Example projects

The following example projects show a rich variety of uses of Read the Docs. You can use them for inspiration, for learning and for recipes to start your own documentation projects. View the rendered version of each project and then head over to the Git repository to see how it’s done and reuse the code.

Real-life examples

We maintain an Awesome List where you can contribute new shiny examples of using Read the Docs. Please refer to the instructions on how to submit new entries on Awesome Read the Docs Projects.

Minimal basic examples

Sphinx

Sphinx example with versioning and Python doc autogeneration.

Markup language: reStructuredText, Markdown or MyST
Rendered version: https://example-sphinx-basic.readthedocs.io/en/latest/>
Repository: https://github.com/readthedocs-examples/example-sphinx-basic/

MkDocs

Basic example of using MkDocs.

Markup language: Markdown
Rendered version: https://example-mkdocs-basic.readthedocs.io/en/latest/
Repository: https://github.com/readthedocs-examples/example-mkdocs-basic/

Jupyter Book

Jupyter Book with popular integrations configured.

Markup language: MyST
Rendered version: https://example-jupyter-book.readthedocs.io/
Repository: https://github.com/readthedocs-examples/example-jupyter-book/

Antora

Antora with asciidoctor-kroki extension configured for AsciiDoc and Diagram as Code.

Markup language: AsciiDoc
Rendered version: https://example-antora-basic.readthedocs.io/
Repository: https://github.com/man-chi/example-antora-basic/

Contributing an example project

We would love to add more examples that showcase features of Read the Docs or great tools or methods to build documentation projects.

We require that an example project:

is hosted and maintained by you in its own Git repository, example-<topic>.
contains a README.
uses a .readthedocs.yaml configuration.
is added to the above list by opening a PR targeting examples.rst file from our documentation.

We recommend that your project:

has continuous integration and PR builds.
is versioned as a real software project, i.e. using git tags.
covers your most important scenarios, but references external real-life projects whenever possible.
has a minimal tech stack – or whatever you feel comfortable about maintaining.
copies from an existing example project as a template to get started.

We’re excited to see what you come up with!