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
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?”
Read the Docs is a community supported site, nobody is paid to handle readthedocs.org support. We are hoping to bring in enough money with our Gold program to change that, so please sign up if you are able.
All people answering your questions are doing it with their own time, so please be kind and provide as much infromation as possible.
Bugs & Support Issues¶
You can file bug reports on our GitHub issue tracker, and they will be addressed as soon as possible. Support is a volunteer effort, and there is no guaranteed response time. If you need answers quickly, you can buy commercial support below.
When reporting a bug, please include as much information as possible that will help us solve this issue. This includes:
- Project name
- Action taken
- Expected result
- Actual result
We offer commercial support for Read the Docs, commercial hosting, as well as consulting around all documentation systems. You can contact us at email@example.com to learn more, or read more at https://readthedocs.com/services/#open-source-support.