Read the Docs
Sphinx projects
10_ENTRIES- CrateDB
Crate.io has integrated their documentation experience into their general website. There's a total of 15 documentation projects nested. They use a custom theme, crate-docs-theme to orchestrate the projects and align them. #sphinx #custom-theme.
- django-cms
django-cms's developer documentation is as extensive as it's well-organized. It uses the Furo theme. #sphinx #large-project.
- Ray
Ray is a documentation project spanning multiple software components. It uses several extensions from the Executable Book project. Features are showcased in this twitter thread. #sphinx #themes #large-project.
- Scrapy
Embeds a lot of reference snippets and uses
sphinx-hoverxreffor quick reference tooltips. Lots of inspiration to be found in content organization. #sphinx. - setuptools
Lots of features, using the Furo theme. Twitter thread with some examples. #sphinx #themes.
- sphinx-needs
Documentation of
sphinx-needs. #sphinx #themes. - sphinx-immaterial
Documentation of
sphinx-immaterial, a Material theme for Sphinx, based on Material for MkDocs. #sphinx #themes. - Uberspace
Customized sidebar and footer, adding project's branding through custom CSS and HTML to
sphinx_rtd_theme. Latest version and release date on front page. #sphinx #themes #custom-theme. - Wagtail
Wagtail is a Django-based CMS with a global community. The documentation spans multiple stakeholders (editors and developers), has it's own beautiful theme and is largely structured around Diátaxis ideals. The Release Notes and Contribution guide are remarkable. Wagtail's documentation uses a minimal set of Sphinx extensions. #sphinx #themes #diataxis.
- Weblate
Weblate is a translation platform with a large documentation project with many translations and customized Read the Docs theme. Documentation aimed at all segments: users, administrators and developers. Also features an extensive Changelog. #sphinx #themes #translation.
MkDocs projects
5_ENTRIES- Argo CD
Material for MkDocs theme with custom colors and a nice version drop down. Animated product demo and carefully designed sidebar presenting targeted guides for Operators, Users and Developers. #mkdocs #themes #large-project.
- doc2dash
Material for MkDocs with a custom version provider fully compatible with Read the Docs #mkdocs #themes.
- Nautobot
Extensive usage of the subprojects feature to organize numerous documentation projects under the same custom domain / landing page. Each subproject has its own release cycle. Features are showcased in this twitter thread. #mkdocs #themes #large-project.
- Sidra Data Platform
Material for MkDocs theme with version selector and search integrated via Read the Docs Addons. #mkdocs #themes #business.
- The Haskell Tool Stack
A matured MkDocs project using their documentation website as their main website. Notice both the structure and the considerate use of widgets included in Material for MkDocs #mkdocs #themes.
API Reference
1_ENTRIES- discord.py
This projects very rich Python API reference uses custom extension for quick overview tables of attributes and methods +
sphinx-hoverxreffor tooltips with API reference + source link references for GitHub source code. #apidocs #sphinx #themes
Science projects
11_ENTRIES- AiiDA demonstration
A hardware demo/tutorial written with lots of examples and illustrations. Behind the scenes, Conda is used by installing mambaforge and storing the setup in
environment.yml. #sphinx #jupyter-notebook - Crest Ocean System
Uses sphinx-hoverxref and Executable Book. Video tutorials in text. Lots of embeds, Trello, YouTube and more. #sphinx #themes
- jupyter-book
Jupyter-book automatically creates Sphinx projects from projects that are friendly to Jupyter Notebook users. #jupyter-notebook #sphinx #diataxis.
- jupyter-sphinx
Directly executes and renders Jupyter Notebooks in documentation projects. #jupyter-notebook #sphinx.
- jupyter-tutorial
Uses a set of extensions for Sphinx, for instance direct rendering of
.ipynbfiles withnbsphinx. #jupyter-notebook #sphinx. - msticpy
MSTIC Jupyter and Python Security Tools, msticpy is a library for InfoSec investigation and hunting in Jupyter Notebooks. #jupyter-notebook #sphinx.
- nbsphinx
Banner and buttons to view interactive versions of currently displayed
*.ipynbfiles using the Binder service. Notice also the awesome PDF version. #jupyter-notebook #sphinx. - poliastro
An extensive science project, demonstrating rich use of math formulas, interactive plotting in 3d,
sphinx-hoverxref, custom 404s and a nice copy button on code examples. Notice how well the navigation reflects the Diátaxis framework #sphinx #diataxis. - SunPy
A large documentation project for an open-source package for solar physics. Embeds the main website's menu and uses a custom theme. Extensive changelog and release notes. #custom-theme, sphinx, #apidocs.
- TorchIO
An open-source Python library targeting 3D medical images in deep learning. Combines API documentation with usage examples, uses "single version" for a singular "rolling release" documentation. Screenshots in this Twitter thread. #themes, sphinx.
- TomoBank
A big list of tomographic datasets and phantoms, featuring especially tables and images and maintained by science community. #sphinx.