{"id":638,"url":"https://github.com/readthedocs-examples/awesome-read-the-docs","last_synced_at":"2025-07-30T19:31:43.940Z","repository":{"id":37451776,"uuid":"505825677","full_name":"readthedocs-examples/awesome-read-the-docs","owner":"readthedocs-examples","description":" A curated list of awesome Read the Docs projects","archived":false,"fork":false,"pushed_at":"2023-07-05T22:50:59.000Z","size":158,"stargazers_count":93,"open_issues_count":4,"forks_count":6,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-05-23T06:07:23.661Z","etag":null,"topics":["awesome","awesome-list"],"latest_commit_sha":null,"homepage":"https://readthedocs.org/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/readthedocs-examples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"license","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-06-21T12:05:06.000Z","updated_at":"2024-05-08T15:53:42.000Z","dependencies_parsed_at":"2024-01-05T20:13:17.672Z","dependency_job_id":"ae91081e-311e-4d65-9beb-fb7393325f3f","html_url":"https://github.com/readthedocs-examples/awesome-read-the-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"jthegedus/awesome-list-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs-examples%2Fawesome-read-the-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs-examples%2Fawesome-read-the-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs-examples%2Fawesome-read-the-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/readthedocs-examples%2Fawesome-read-the-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/readthedocs-examples","download_url":"https://codeload.github.com/readthedocs-examples/awesome-read-the-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228178834,"owners_count":17881100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["awesome","awesome-list"],"created_at":"2024-01-05T20:13:00.805Z","updated_at":"2024-12-04T19:31:42.838Z","avatar_url":"https://github.com/readthedocs-examples.png","language":null,"funding_links":[],"categories":["Miscellaneous","Uncategorized","Themed Directories"],"sub_categories":["Uncategorized","Updated more than a year ago"],"readme":"\u003c!--lint ignore awesome-git-repo-age--\u003e\n\u003c!--lint disable double-link--\u003e\n\n\u003c!-- title --\u003e\n\n# 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)\n\n\u003c!-- subtitle --\u003e\n\n\u003e A curated list of awesome documentation projects, useful to learn from and for bootstrapping new documentation projects.\n\u003e Plus cool real-life usages of Read the Docs.\n\n\u003c!-- image --\u003e\n\n\u003ca href=\"https://docs.readthedocs.io/en/stable/tutorial/index.html\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n  \u003cimg src=\"./readthedocs-logo.svg\" /\u003e\n\u003c/a\u003e\n\n\u003c!-- description --\u003e\n\nRead the Docs is a fully open-source platform that builds and publishes documentation.\nRead more on https://about.readthedocs.com.\n\n## Foreword\n\nMany new and exciting documentation projects have emerged in *science and academia*, taking the world of documentation beyond just software projects.\nTo capture the latest development and trends, we are compiling a list of inspirational uses of documentation technology, especially outside of the traditional field of software documentation.\n\nIn addition to showing awesome and real-life Read the Docs projects, a number of [Example Projects](#example-projects) are being built to help people learn and get started.\n\nWe hope that this will inspire people writing documentation, developing new documentation projects or updating existing ones.\nAll projects mentioned here are **open source**, meaning that you can find their source code and understand how it's done.\n\nThe list is a work in progress, please feel invited to [contribute](#contributing)!\n\n\u003c!-- TOC --\u003e\n\u003c!--lint disable awesome-toc--\u003e\n## Contents\n\u003c!--lint enable awesome-toc--\u003e\n\n- [Sphinx projects](#sphinx-projects)\n- [MkDocs projects](#mkdocs-projects)\n- [API Reference](#api-reference)\n- [Science projects](#science-projects)\n- [Tag cloud](#tag-cloud)\n\n\u003c!-- CONTENT --\u003e\n\n\n## Sphinx projects\n\n- [CrateDB](https://crate.io/docs/crate/) - 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](https://github.com/crate/crate-docs-theme) to orchestrate the projects and align them. **#sphinx** **#custom-theme**.\n- [django-cms](https://docs.django-cms.org/) - django-cms's developer documentation is as extensive as it's well-organized. It uses the Furo theme. **#sphinx** **#large-project**.\n- [Ray](https://docs.ray.io/) - 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](https://twitter.com/readthedocs/status/1663923671470047234). **#sphinx** **#themes** **#large-project**.\n- [Scrapy](https://docs.scrapy.org/) - Embeds a lot of reference snippets and uses `sphinx-hoverxref` for quick reference tooltips. Lots of inspiration to be found in content organization. **#sphinx**.\n- [setuptools](https://setuptools.pypa.io/) - Lots of features, using the Furo theme. [Twitter thread](https://twitter.com/readthedocs/status/1546527820150718469) with some examples. **#sphinx** **#themes**.\n- [sphinx-needs](https://sphinx-needs.readthedocs.io/) - Documentation of `sphinx-needs`. **#sphinx** **#themes**.\n- [sphinx-immaterial](https://sphinx-immaterial.readthedocs.io/) - Documentation of `sphinx-immaterial`, a Material theme for Sphinx, based on Material for MkDocs. **#sphinx** **#themes**.\n- [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**.\n- [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**.\n- [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**.\n\n## MkDocs projects\n\n- [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**.\n- [doc2dash](https://doc2dash.readthedocs.io/) - Material for MkDocs with a custom version provider fully compatible with Read the Docs **#mkdocs** **#themes**.\n- [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**.\n- [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**.\n- [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**.\n\n## API Reference\n\n- [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**\n\n## Science projects\n\n- [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**\n- [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**\n- [jupyter-book](https://jupyterbook.org/) - Jupyter-book automatically creates Sphinx projects from projects that are friendly to Jupyter Notebook users. **#jupyter-notebook** **#sphinx** **#diataxis**.\n- [jupyter-sphinx](https://jupyter-sphinx.readthedocs.io/) - Directly executes and renders Jupyter Notebooks in documentation projects. **#jupyter-notebook** **#sphinx**.\n- [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**.\n- [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**.\n- [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**.\n- [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**.\n- [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**.\n- [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**.\n- [TomoBank](https://tomobank.readthedocs.io/) - A big list of tomographic datasets and phantoms, featuring especially tables and images and maintained by science community. **#sphinx**.\n\n\u003c!-- END CONTENT --\u003e\n\n## Tag cloud\n\nThe categories in this list are intersecting at the following tags:\n\n**#sphinx**, **#mkdocs**, **#themes**, **#custom-theme**, **#jupyter-notebook**, **#diataxis**, **#large-project**, **#apidocs**, **#translation**\n\n## Contributing\n\n[Contributions of any kind welcome, just follow the guidelines](contributing.md)!\n\n### Contributors\n\n[Thanks goes to these contributors](https://github.com/readthedocs-examples/awesome-read-the-docs/graphs/contributors)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadthedocs-examples%2Fawesome-read-the-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freadthedocs-examples%2Fawesome-read-the-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freadthedocs-examples%2Fawesome-read-the-docs/lists"}