Frequently Asked Questions
Answers to common documentation questions and how-tos for Read the Docs.
How do I create a new project?
Use the Admin panel to create a new project. Go to your account, select "Projects" and click "Add new project." You can either build documentation from a version control system link or upload directly.
How do I manage documentation versions?
In the project dashboard, go to "Versions." You can create, edit, or delete documentation versions. Each version corresponds to a specific build of your documentation.
How can I integrate documentation with my code?
Connect your Git repository (GitHub, GitLab, Bitbucket) during project setup. This allows Read the Docs to automatically build docs on commits and pull requests.
How do I use the API?
Visit our API documentation for endpoint details. Use an API token for authentication.
Why won't my documentation build?
Ensure your documentation source files (like .rst or .md files) exist in the correct directory. Check the "Build logs" tab for error details. Common issues include missing configuration or dependencies.