Documentation now builds. You can build it by running make html from the docs/ folder. Then, you can open the documentation by running open ./_build/index.html.
The documentation:
Automatically creates html pages from notebooks in the docs/examples folders. Please add the tutorials there. In order for them to be linkable, you need to append the notebook name to the docs/examples/index.rst file
Supports latex math (as in the docs/index.rst file)
Automatically renders stuff from the API using the docstrings from the code. For example, I generate the RobustProblem documentation automatically by listing it in the docs/api/index.rst file. However, there are several things to cleanup in the docstrings. Please do follow the numpy style
@colbeck could you please take a look and start populating the other pages of the docs? You can make edits in the docs branch.
Documentation now builds. You can build it by running
make htmlfrom thedocs/folder. Then, you can open the documentation by runningopen ./_build/index.html.The documentation:
docs/examplesfolders. Please add the tutorials there. In order for them to be linkable, you need to append the notebook name to thedocs/examples/index.rstfiledocs/index.rstfile)RobustProblemdocumentation automatically by listing it in thedocs/api/index.rstfile. However, there are several things to cleanup in the docstrings. Please do follow the numpy style@colbeck could you please take a look and start populating the other pages of the docs? You can make edits in the
docsbranch.