Free documentation hosting for the Open Source community
Read The Docs is a free website providing documentation hosting for open source software, using either Sphinx or MkDocs. It can pulls from Subversion, Bazaar, Git and Mercurial repositories.
Questions tagged [read-the-docs]
548 questions
4
votes
1 answer
How do I tell readthedocs which requirements file to load ?
My readthedocs.org build just started failing ... I am not sure why exactly and not particularly adept at Sphynx. I don't understand why it's attempting to build things for requirements files outside of the docs directory or why it can't find this…
thornomad
- 6,707
- 10
- 53
- 78
4
votes
1 answer
How can I get readthedocs.org build to ignore my requirement.txt?
I have a small app project on github which runs on Windows and requires pythonnet.
My requirement.txt contains:
beautifulsoup4==4.6
pythonnet==2.3
Now I thought I would build a documentation for it and put it on readthedocs.org. After pushing my…
Jacques Gaudin
- 15,779
- 10
- 54
- 75
4
votes
1 answer
Integrate Piwik tracking code into Sphinx-generated docs hosted on readthedocs.io
While readthedocs.io offers the possibility to enable Google Analytics for a page by just adding the tracking ID within a project's settings, the same offer does not seem to exists for using Piwik.
I would like to use Piwik for a page that I…
mindm49907
- 278
- 2
- 10
4
votes
3 answers
How to hide the sidebar using Sphinx RTD theme when making htmlhelp
Is it possible to hide the sidebar when using Sphinx with the ReadTheDocs theme?
Extending the question a bit more, can I have it include the sidebar when issuing a command:
$ make html
and not include it issuing a command:
$ make…
Hank
- 2,456
- 3
- 35
- 83
4
votes
1 answer
Why doesn't Sphinx translate :kbd: roles to HTML's tags?
I want to mark keyboard keys and inputs as key "icons". Sphinx provides a :kbd: role to markup single characters or words, but the resulting HTML contains
tags.
So why doesn't Sphinx translate :kbd: roles to HTML's …
Paebbels
- 15,573
- 13
- 70
- 139
4
votes
0 answers
ReadTheDocs activation email not deliverd
I tried to install ReadTheDocs on my linux server following the documentation: http://read-the-docs.readthedocs.io/en/latest/install.html
However I do not receive the activation email.
I was able to see the output of the email on the server
Hello…
Szenis
- 4,020
- 2
- 21
- 34
4
votes
2 answers
How can I change text justification to 'justify' for the ReadTheDocs Sphinx theme?
I'm writing a new documentation for my project in reST. The documentation is rendered with Sphinx on ReadTheDocs. I already downloaded the ReadTheDocs theme as a git submodule into my repositories docs/source/_themes folder, so I can modify some of…
Paebbels
- 15,573
- 13
- 70
- 139
4
votes
1 answer
PyQt 4 import in read-the-docs
I am currently in the process of getting the documentation of my code online via read-the-docs, however, getting read-the-docs to process my PyQt4 dependent modules seems problematic.
My project has the following…
alexblae
- 746
- 1
- 5
- 13
4
votes
3 answers
How to use Python 3.5 syntax in readthedocs combined with autodoc?
I would like to generate documentation (including automatically generated documentation with autodoc) for my project using readthedocs.org. However, my project uses Python 3.5 syntax (async and await) and it doesn't look like it can handle that. The…
Evert Heylen
- 960
- 9
- 28
4
votes
3 answers
Removing the Edit on Github link when using Read The Docs & Sphinx with ReadTheDocs Theme
I'm trying to find out how to use the _template overrides option in Sphinx to override the default ReadTheDocs theme for hosting Sphinx documentation on http://readthedocs.org.
Specifically, I'm wanting to remove/hide the "Edit on Github" link shown…
Brian King
- 474
- 3
- 13
4
votes
1 answer
How to structure Sphinx docs for lots of modules
How do I best structure Sphinx docs (for Read the Docs) if I need to both support "regular" prose documentation and API documentation for 30+ modules?
There are a number (<10) of regular prose documentation pages such as "Getting started", "Building…
Marcel Stör
- 22,695
- 19
- 92
- 198
4
votes
2 answers
Read The Docs: Change menu-order (.md)
Does anybody know how to change the menu-order when using .md?
I can't find it. I know it's possible with other types like .rst, but I use .md
Thank you!
Bob
- 873
- 1
- 8
- 21
3
votes
1 answer
How can I wrap text inside a cell to get a table from a csv file in the Sphinx documentation created using Restructured text (RST) files?
I want to add a table from a csv file in the Sphinx documentation.
In the rst file, I used the csv-table directive as follows:
.. csv-table:: xyz
:header-rows: 1
:file: path/file.csv
:widths: 20, 30, 50
As a result, I get…
hbstha123
- 1,260
- 11
- 23
3
votes
1 answer
Readthedocs custom domain stops working with ssl issue
I got problems with my custom domain setup on readthedocs.
Suddenly custom domain (https://docs.joinrpg.ru) stops working with SSL_ERROR_NO_CYPHER_OVERLAP.
Variois SSL checkers report that they "Failed to communicate with the secure…
Leotsarev
- 1,040
- 7
- 23
3
votes
1 answer
ReadTheDocs trouble with sklearn/umap
I've got a package which I've previously successfully built on ReadTheDocs, but this is no longer the case. My imports are as follows:
import pandas as pd
import numpy as np
import scipy
import sys
from annoy import AnnoyIndex
from packaging import…
ktpolanski
- 31
- 3