Read the docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more. Learn about documentation authoring tools such as sphinx and mkdocs to help you create fantastic documentation for your project Learn more about configuring your automated documentation builds and some of the core features of read the docs. Get your docs online in 5 minutes. Read the docs simplifies managing software documentation by building and hosting your docs automatically, using the git workflow you already use for code Treating documentation like code lets your team use tools they already know, and makes keeping your docs updated easier.
Please create an index.md or readme.md file with your own content under the root (or /docs) directory in your repository If you want to use another markup, choose a different builder in your settings Check out our getting started guide To set stable as the default version, rather than latest, so that users see the stable documentation when they visit the root url of your documentation In the ⚙ admin menu of your project home, go to the settings link, choose stable in the “default version*” dropdown, and hit save at the bottom. Read the docs simplifies software documentation by automating building, versioning, and hosting of your docs for you
Each version of your project has a unique url identifier (slug) This identifier is used to reference the version in your documentation, dashboard, and api. Learn about the differences between read the docs community and read the docs for business Get familiar with some of the more advanced topics of building and deploying documentation with read the docs Browse all our explanation articles Need to get something specific done?
OPEN
