ReadTheDocs Documentation System

Contents:

• Getting Started with Sphinx
  • Quick start video
  • Quick start
  • Using Markdown with Sphinx
  • External resources
• Getting Started with MkDocs
  • Quick start
  • External resources
• Importing Your Documentation
  • Manually import your docs
  • Building your documentation
• docutils reStructuredText Directives - This is the official definition - This is the true resource
  • Admonitions
  • Images
  • Body Elements
  • Tables
  • Document Parts
  • References
  • HTML-Specific
  • Directives for Substitution Definitions
  • Miscellaneous
  • Common Options
• reStructured Text Special directives
  • Special directives
• colored boxes: note, seealso, todo and warnings
• Paragraph Level Markup
• Custom Domains and White Labeling
  • Subdomain support
  • Custom domain support
  • Proxy SSL
• ReadTheDocs - Frequently Asked Questions
  • My project isn’t building correctly
  • Help, my build passed but my documentation page is 404 Not Found!
  • My documentation requires additional dependencies
  • My project requires some additional settings
  • I get import errors on libraries that depend on C modules
  • How do I change behavior when building with Read the Docs?
  • Client Error 401 when building documentation
  • Deleting a stale or broken build environment
  • How do I host multiple projects on one custom domain?
  • Where do I need to put my docs for RTD to find it?
  • I want to use the Blue/Default Sphinx theme
  • I want to use the Read the Docs theme locally
  • Image scaling doesn’t work in my documentation
  • I want comments in my docs
  • How do I support multiple languages of documentation?
  • Does Read The Docs work well with “legible” docstrings?
  • Can I document a python package that is not at the root of my repository?
  • I need to install a package in a environment with pinned versions
  • How can I avoid search results having a deprecated version of my docs?
  • Can I remove advertising from my documentation?
  • How do I change my project slug (the URL your docs are served at)?
  • How do I change the version slug of my project?
  • What commit of Read the Docs is in production?
• Canonical URLs
  • Example
  • Enabling
  • Implementation
  • Links
• Enabling Google Analytics on your Project
  • Disabling Google Analytics on your project
• User-defined Redirects
  • Quick Summary
  • Redirect Types
  • Implementation
• Technical Documentation Search Engine Optimization (SEO) Guide
  • SEO Basics
  • Optimizing your docs for search engine spiders
  • Measure, iterate, & improve
  • External resources
• Wiping a Build Environment
• Feature Flags
  • Available Flags
• Reproducible Builds
  • Building your docs
  • Using a configuration file
  • Don’t rely on implicit dependencies
  • Pinning dependencies
• Localization of Documentation
  • Single project in another language
  • Project with multiple translations
• Manage Translations
  • Overview
  • Create translatable files
  • Translate text from source language
  • Build the documentation in target language
  • Summary

ReadTheDocs Documentation System

This project is built with software from a project called ReadTheDocs

Purpose

Read the Docs hosts documentation for the open source community. It supports Sphinx docs written with reStructuredText, and can pull from your Subversion, Bazaar, Git, and Mercurial repositories. Then we build documentation and host it for you. Think of it as Continuous Documentation.

Documentation for RTD

You will find complete documentation for setting up your project at the Read the Docs site.

ReadTheDocs Theme and Demo Documentation

https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html

THEME DOCUMENTATION

• Installation https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html

• Configuration https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html

• Theme options https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options

• How the table of contents displays https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#how-the-table-of-contents-displays

DEMO DOCUMENTATION

1. Structural Elements https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/structure.html

2. Structural Elements 2 https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/structure.html#structural-elements-2

3. Paragraph Level Markup https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/demo.html

4. Lists & Tables https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/lists_tables.html

5. API documentation and generated content https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/api.html

Last change: Tue, 03 Aug 2021 10:25 PM UTC