This is the repository where documentation for SimCenter software is maintained. The current documentation is in restructred text format and is built using the sphinx python module.
Contributors should follow the style reference for guidelines on documentation formatting.
- docs - the folder containing the most up to date material (all other directories contain legacy material)
- docs/Makefile - Linux and MacOS makefile for building current document
- docs/make.bat - Windows make.bat to do same thing
- docs/conf.py - configuration file (in this file set app for which doc is requiretd)
- docs/index.rst - main index file, which pulls in files in docs/common
- otherFolder - ignore as these contain legacy text files
pip install -U -r requirements.txt
git clone https://github.com/NHERI-SimCenter/SimCenterDocumentation.git
cd SimCenterDocumentation
cd docs
make html
on Linux type the following to open a browser with index page
xdg-open ./build/html/index.html
on a Mac
open ./_build/html/index.html