A customizable documentation template using the Sphinx Book Theme, designed for readable, navigable, and professionally styled docs. This template is suitable for research projects, open-source libraries, robotics stacks, or any technical documentation.
- Book-style layout optimized for long-form documentation
- Supports Jupyter notebooks, Markdown, and reStructuredText
- Automatic sidebar generation
- Includes a custom theme (light and dark mode)
- Ready for API docs with autodoc/autosummary support
- Easily deployable with GitHub Pages
- Modular folder structure
For the latest documentation, see Sphinx Book Theme Template.
Ensure that your system is up with the following:
- Operating System: Ubuntu 22.04
- GPU: For additional information on GPU features and requirements, see NVIDIA GPU Requirements.
Please see the FAQ, Troubleshooting and Known Issues for common questions, fixes, and workarounds.
Github Issues should only be used to track executable pieces of work with a definite scope and a clear deliverable. These can be fixing bugs, documentation issues, new features, or general updates.
The license files of it depedencies and assets are present in the 'docs/licenses' directory.
If you use Sphinx Book Theme Template, please consider citing:
@misc{Sphinx Book Theme Template,
author = {Trushant Adeshara},
title = {Sphinx Book Theme Template},
month = {July},
year = {2025},
url = {https://github.com/trushant05/sphinx_book_theme_template}
}