Search results for “site:docs.readthedocs.io”

About 6 results

docs.readthedocs.io page › tutorial

Read the Docs tutorial — Read the Docs user documentation

In this tutorial you will learn how to host a public documentation project on Read the Docs Community. In the tutorial we will: Import a Sphinx project from a GitHub repository (no prior experience with Sphinx is required)., Tailor the project’s configuration., Explore other useful Read the Docs ...

docs.readthedocs.io page › config-file

Configuration file overview — Read the Docs user documentation

As part of the initial set up of a Read the Docs project, you need to create a configuration file called.readthedocs.yaml. The configuration file tells Read the Docs what specific settings to use for your project. This tutorial covers: Where to put your configuration file, Getting started with a ...

docs.readthedocs.io page › support.html

Site support — Read the Docs user documentation

Read the Docs offers support for projects on our Read the Docs for Business and Read the Docs Community platforms. We’re happy to assist with any questions or problems you have using either of our platforms. Some examples of requests that we support are: “How do I transfer ownership of a Read the...

docs.readthedocs.io en › stable › user-defined-redirects.html

Redirects — Read the Docs user documentation

Over time, a documentation project may want to rename and move contents around. Redirects allow changes in a documentation project to happen without bad user experiences. If you do not manage URL structures, users will eventually encounter 404 File Not Found errors. While this may be acceptable i...

docs.readthedocs.io en › stable › guides › custom-domains.html

How to manage custom domains — Read the Docs user documentation

This guide describes how to host your documentation using your own domain name, such as docs.example.com. Contents: Adding a custom domain, Removing a custom domain, Strict Transport Security (HSTS) and other custom headers, Multiple documentation sites as sub-folders of a domain, Troubleshooting...

Try “site:docs.readthedocs.io” on: Marginalia · Mojeek · Wiby · DuckDuckGo · Bing · Google · Wikipedia · Internet Archive