update lists

This commit is contained in:
2025-07-18 22:22:32 +02:00
parent 55bed3b4a1
commit 5916c5c074
3078 changed files with 331679 additions and 357255 deletions

View File

@@ -3,8 +3,8 @@
 Awesome Read the Docs !Awesome (https://awesome.re/badge.svg) (https://awesome.re) !lint (https://github.com/readthedocs-examples/awesome-read-the-docs/actions/workflows/lint.yaml/badge.svg) 
 (https://github.com/readthedocs-examples/awesome-read-the-docs/actions/workflows/lint.yaml)
 Awesome Read the Docs !Awesome (https://awesome.re/badge.svg) (https://awesome.re) !lint (https://github.com/readthedocs-examples/awesome-read-the-docs/actions/workflows/lint.yaml/badge.svg) 
 (https://github.com/readthedocs-examples/awesome-read-the-docs/actions/workflows/lint.yaml)
@@ -20,7 +20,7 @@
Read the Docs is a fully open-source platform that builds and publishes documentation.
Read more on readthedocs.org (https://readthedocs.org/) and readthedocs.com (https://readthedocs.com/) (Read the Docs for Business).
Read more on https://about.readthedocs.com.
Foreword
@@ -43,7 +43,6 @@
- MkDocs projects (#mkdocs-projects)
- API Reference (#api-reference)
- Science projects (#science-projects)
- Example projects (#example-projects)
- Tag cloud (#tag-cloud)
@@ -61,53 +60,47 @@
- sphinx-needs (https://sphinx-needs.readthedocs.io/) - Documentation of sphinx-needs. #sphinx #themes.
- sphinx-immaterial (https://sphinx-immaterial.readthedocs.io/) - Documentation of sphinx-immaterial, a Material theme for Sphinx, based on Material for MkDocs. #sphinx #themes.
- Uberspace (https://manual.uberspace.de/) - 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 (https://docs.wagtail.org/) - 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 (https://docs.wagtail.org/en/stable/releases/index.html) and Contribution guide (https://docs.wagtail.org/en/stable/contributing/index.html) are remarkable. Wagtail's documentation uses a minimal set 
of Sphinx extensions. #sphinx #themes #diataxis.
- Weblate (https://docs.weblate.org/) - 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.
- Wagtail (https://docs.wagtail.org/) - 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 (https://docs.wagtail.org/en/stable/releases/index.html) and Contribution guide (https://docs.wagtail.org/en/stable/contributing/index.html) are remarkable. Wagtail's documentation uses a minimal set of Sphinx extensions. 
#sphinx #themes #diataxis.
- Weblate (https://docs.weblate.org/) - 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
- Argo CD (https://argo-cd.readthedocs.io/) - 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.
- Argo CD (https://argo-cd.readthedocs.io/) - 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 (https://doc2dash.readthedocs.io/) - Material for MkDocs with a custom version provider fully compatible with Read the Docs #mkdocs #themes.
- Nautobot (https://docs.nautobot.com/) - 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 (https://twitter.com/readthedocs/status/1595010133796462593). #mkdocs #themes #large-project.
- The Haskell Tool Stack (https://docs.haskellstack.org/) - 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.
- Nautobot (https://docs.nautobot.com/) - 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 (https://twitter.com/readthedocs/status/1595010133796462593). #mkdocs #themes #large-project.
- Sidra Data Platform (https://docs.sidra.dev/en/latest/) - Material for MkDocs theme with version selector and search integrated via Read the Docs Addons. #mkdocs #themes #business.
- The Haskell Tool Stack (https://docs.haskellstack.org/) - 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
- discord.py (https://discordpy.readthedocs.io/) - This projects very rich Python API reference uses custom extension for quick overview tables of attributes and methods + sphinx-hoverxref for tooltips with API reference + source link 
references for GitHub source code. #apidocs #sphinx #themes
- discord.py (https://discordpy.readthedocs.io/) - This projects very rich Python API reference uses custom extension for quick overview tables of attributes and methods + sphinx-hoverxref for tooltips with API reference + source link references 
for GitHub source code. #apidocs #sphinx #themes
Science projects
- AiiDA demonstration (https://aiida-qe-demo.readthedocs.io/) - A hardware demo/tutorial written with lots of examples and illustrations. Behind the scenes (https://github.com/chrisjsewell/aiida-qe-demo), Conda is used by installing 
mambaforge and storing the setup in environment.yml. #sphinx #jupyter-notebook
- AiiDA demonstration (https://aiida-qe-demo.readthedocs.io/) - A hardware demo/tutorial written with lots of examples and illustrations. Behind the scenes (https://github.com/chrisjsewell/aiida-qe-demo), Conda is used by installing mambaforge 
and storing the setup in environment.yml. #sphinx #jupyter-notebook
- Crest Ocean System (https://crest.readthedocs.io/) - Uses sphinx-hoverxref and Executable Book. Video tutorials in text. Lots of embeds, Trello, YouTube and more. #sphinx #themes
- jupyter-book (https://jupyterbook.org/) - Jupyter-book automatically creates Sphinx projects from projects that are friendly to Jupyter Notebook users. #jupyter-notebook #sphinx #diataxis.
- jupyter-sphinx (https://jupyter-sphinx.readthedocs.io/) - Directly executes and renders Jupyter Notebooks in documentation projects. #jupyter-notebook #sphinx.
- jupyter-tutorial (https://jupyter-tutorial.readthedocs.io/) - Uses a set of extensions for Sphinx, for instance direct rendering of .ipynb files with nbsphinx. #jupyter-notebook #sphinx.
- msticpy (https://msticpy.readthedocs.io/) - MSTIC Jupyter and Python Security Tools, msticpy is a library for InfoSec investigation and hunting in Jupyter Notebooks. #jupyter-notebook #sphinx.
- nbsphinx (https://nbsphinx.readthedocs.io/) - Banner and buttons to view interactive versions of currently displayed *.ipynb files using the Binder service. Notice also the awesome PDF version. #jupyter-notebook #sphinx.
- poliastro (https://docs.poliastro.space/) - 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 (https://diataxis.fr/) #sphinx #diataxis.
- SunPy (https://docs.sunpy.org/) - 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 (https://torchio.readthedocs.io/) - 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 (https://twitter.com/readthedocs/status/1570339818806120450). #themes, sphinx.
- poliastro (https://docs.poliastro.space/) - 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 (https://diataxis.fr/) #sphinx #diataxis.
- SunPy (https://docs.sunpy.org/) - 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 (https://torchio.readthedocs.io/) - 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 (https://twitter.com/readthedocs/status/1570339818806120450). #themes, sphinx.
- TomoBank (https://tomobank.readthedocs.io/) - A big list of tomographic datasets and phantoms, featuring especially tables and images and maintained by science community. #sphinx.
Example projects
- Basic Sphinx example (https://github.com/readthedocs-examples/example-sphinx-basic) - Basic example of using Sphinx on Read the Docs. #sphinx.
- Basic MkDocs example (https://github.com/readthedocs-examples/example-mkdocs-basic) - Basic example of using MkDocs on Read the Docs. #mkdocs.
- Jupyter Book example (https://github.com/readthedocs-examples/example-jupyter-book) - Using Jupyter Book on Read the Docs with popular extensions. #jupyter-notebook #sphinx.
Tag cloud
The categories in this list are intersecting at the following tags:
@@ -121,3 +114,5 @@
Contributors
Thanks goes to these contributors (https://github.com/readthedocs-examples/awesome-read-the-docs/graphs/contributors)!
readthedocs Github: https://github.com/readthedocs-examples/awesome-read-the-docs