Usage Questions

If you have questions about how to use Read the Docs, or have an issue that isn’t related to a bug, Stack Overflow is the best place to ask. Tag questions with read-the-docs so other folks can find them easily.

Good questions for Stack Overflow would be:

  • “What is the best way to structure the table of contents across a project?”

  • “How do I structure translations inside of my project for easiest contribution from users?”

  • “How do I use Sphinx to use SVG images in HTML output but PNG in PDF output?”

User Support

If you need a specific request for your project or account, like more resources, change of the project’s slug or username. Send an email to We will get to you as soon as possible.

Bug Reports

You can file bug reports on our GitHub issue tracker, and they will be addressed as soon as possible. Please only file issues with our actual codebase there, not user support questions

Reporting Issues

When reporting a bug, please include as much information as possible that will help us solve this issue. This includes:

  • Project name

  • URL

  • Action taken

  • Expected result

  • Actual result

Priority Support

We offer priority support with Read the Docs for Business and we have a dedicated team that responds to support requests during business hours.