Building the labscript suite docs¶
The labscript-suite documentation is hosted online at https://docs.labscriptsuite.org/en/latest/.
It is composed from documentation for each module of the labscript-suite.
If you desire to build the documentation for a module locally, either for off-line usage or to test changes to the documentation, you will need to apply extra configuration beyond a normal installation.
This is because our documentation building pipeline relies on sphinx, which introspects documentation from inline docstrings from the source code.
This introspection process requires that the code to be documented is importable and the necessary
sphinx dependencies are installed.
The below sections describe how to configure your environment for building docs as well as some guidance for writing and contributing documentation.
- Setting up the environment
- Building the Docs
- Writing Docs
- Committing Docs
- Documentation Resources