This repository contains the source code for the tudat-space website, found under docs.tudat.space. The website contains a getting-started section for new users, a comprehensive user-guide along with some background information on the Tudat project. It is built using Sphinx.
For more details on the Tudat project, we refer to the project website and our project Github page.
The tudat-space repository contains the docs directory, which hosts all information required to build the tudat-space website:
tudat-space/docs/source, where the source of the website is written in.rstfiles.tudat-space/docs/environment.yaml, which holds information to create thetudat-docsenvironment. This environment is used to build the website locally and on ReadtheDocs.tudat-space/.readthedocs.ymlcontains the configuration for the online build on ReadtheDocs.- (If the documentation has been built locally):
tudat-space/docs/build, which contains the local build in.htmlfiles.
The examples on the website are integrated using the tudatpy-examples repository as a submodule.
If you would like to add examples or make changes, please contribute in the tudatpy-examples repository.
This repository will be automatically updated from the Sync tudat-space submodule action.
If you see anything on the website you would like to improve, you can leave your thoughts on our discussion board or make the modifications yourself and open a pull request. Detailed instruction for developing and building the website (locally or online) are provide on our wiki.
In short, run the following command with the provided tudat-docs conda environment:
sphinx-build -b html docs/source docs/buildYou can then open the docs/build/index.html file with your preferred browser.