awesome-read-the-docs
doc examples
A curated list of documentation projects showcasing best practices and real-world applications
A curated list of awesome Read the Docs projects
150 stars
6 watching
7 forks
last commit: 6 months ago
Linked from 1 awesome list
awesomeawesome-listdocumentationread-the-docs
Awesome Read the Docs / Sphinx projects | |||
| 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, to orchestrate the projects and align them. | ||
| django-cms | django-cms's developer documentation is as extensive as it's well-organized. It uses the Furo theme. | ||
| Ray | Ray is a documentation project spanning multiple software components. It uses several extensions from the Executable Book project. Features are showcased in . | ||
| Scrapy | Embeds a lot of reference snippets and uses for quick reference tooltips. Lots of inspiration to be found in content organization. | ||
| setuptools | Lots of features, using the Furo theme. with some examples. | ||
| sphinx-needs | Documentation of . | ||
| sphinx-immaterial | Documentation of , a Material theme for Sphinx, based on Material for MkDocs. | ||
| Uberspace | Customized sidebar and footer, adding project's branding through custom CSS and HTML to . Latest version and release date on front page. | ||
| 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 and are remarkable. Wagtail's documentation uses a minimal set of Sphinx extensions. | ||
| 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. | ||
Awesome Read the Docs / MkDocs projects | |||
| 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. | ||
| doc2dash | Material for MkDocs with a custom version provider fully compatible with Read the Docs | ||
| 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 . | ||
| Sidra Data Platform | Material for MkDocs theme with version selector and search integrated via Read the Docs Addons. | ||
| 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 | ||
Awesome Read the Docs / API Reference | |||
| discord.py | This projects very rich Python API reference uses custom extension for quick overview tables of attributes and methods + for tooltips with API reference + source link references for GitHub source code | ||
Awesome Read the Docs / Science projects | |||
| AiiDA demonstration | A hardware demo/tutorial written with lots of examples and illustrations. , Conda is used by installing mambaforge and storing the setup in | ||
| Crest Ocean System | Uses sphinx-hoverxref and Executable Book. Video tutorials in text. Lots of embeds, Trello, YouTube and more | ||
| jupyter-book | Jupyter-book automatically creates Sphinx projects from projects that are friendly to Jupyter Notebook users. | ||
| jupyter-sphinx | Directly executes and renders Jupyter Notebooks in documentation projects. | ||
| jupyter-tutorial | Uses a set of extensions for Sphinx, for instance direct rendering of files with . | ||
| msticpy | MSTIC Jupyter and Python Security Tools, msticpy is a library for InfoSec investigation and hunting in Jupyter Notebooks. | ||
| nbsphinx | Banner and buttons to view interactive versions of currently displayed files using the Binder service. Notice also the awesome PDF version. | ||
| poliastro | An extensive science project, demonstrating rich use of math formulas, interactive plotting in 3d, , custom 404s and a nice copy button on code examples. Notice how well the navigation reflects the | ||
| 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. , , | ||
| 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. . , | ||
| TomoBank | A big list of tomographic datasets and phantoms, featuring especially tables and images and maintained by science community. | ||
sindresorhus/awesome