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
0
votes
1 answer
Variable External Links based on `sphinx-build` destination (eg: html vs pdf)
How can I have sphinx add a link that varies based on the build destination, such as html or pdf?
I'd like to add an external link to my reStructuredText file such that it points to:
example.com/a when sphinx is building an html file…
Michael Altfield
- 2,083
- 23
- 39
0
votes
1 answer
How to add a spreadsheet in Read the Docs?
What's the best way to add a spreadsheet to my documentation using Read the Docs?
I'm working on an open-source project that produces open-source hardware and software. A ubiquitous section of open-source hardware projects' documentation is a Bill…
Michael Altfield
- 2,083
- 23
- 39
0
votes
1 answer
Removing borders from a table in sphinx documentation
I have a table in in an rst file I am hosting on readthedocs that I would like to remove the borders from. Trouble is, nothing I try in the CSS file seems to work. I've looked at several other solutions SO and haven't yet had success.
Here is a…
Dez M
- 57
- 5
0
votes
1 answer
How to enable fully expanded breadcrumbs with Sphinx RTD and AutoAPI?
I'm experimenting with the Sphinx AutoAPI to make docs more maintainable. It's doing a great job, except for one thing: breadcrumbs.
Within the docs generated by AutoAPI, breadcrumbs don't work as I'd expect. Instead of adding a linked item at each…
Abe
- 22,738
- 26
- 82
- 111
0
votes
1 answer
Readthedocs local install: RuntimeError: Click will abort further execution because Python 3 was configured to use ASCII as encoding
I'm running a local install of readthedocs 5.1, and I'm building a project by running python manage.py update_repos. I get the following error:
Traceback (most recent call last):
File "/readthedocs.org/readthedocs/projects/tasks.py", line 767, in…
luds
- 331
- 2
- 13
0
votes
1 answer
Download roles are not working on Read the Docs
I'm trying to get a download link to work in Read the Docs using reStructuredText (reST) and Sphinx. In the reST documentation for the download role the example to provide a download link is given as
.. only:: builder_html
See :download:`this…
bicarlsen
- 1,241
- 10
- 27
0
votes
1 answer
Readthedocs - need sphinx 2.1+ to process the :async: option
My first public Python project is now on readthedocs (RTD). There is one problem I'm trying to fix, but without success so far.
I'm using the :async: option to mark coroutines. This is supported by sphinx 2.1+. RTD used sphinx 1.8.5 for my project.…
VPfB
- 14,927
- 6
- 41
- 75
0
votes
1 answer
Html clickable images; org mode, org-mode-info or readtheorg
So I'm using org-mode html export functionality and it works perfectly fine; especially with either of these great themes!
My main concern is merely about images. While i was installing mu4e, there was an image that i couldn't preview, which made me…
Hasan Sh
- 1,018
- 9
- 16
0
votes
0 answers
How to include an external library in the build of the Sphinx documentation
Is there a way to include an external library when building the Sphinx documentation? Specifically, I try to build the documentation on readthedocs but the Python package relies on an external Fortran library which has to be build and added to the…
Tomas
- 503
- 2
- 7
- 15
0
votes
2 answers
Build error "There must be only one argument: DEST_DIR "
After following the official RTD installation tutorial for ubuntu18 I manage to do everything (even webhooks) until the point of building, for a project called test, where I get the following error:
python3.6 -mvirtualenv …
miguels
- 606
- 1
- 7
- 30
0
votes
1 answer
Can I build multiple PDFs from the same source in readthedocs?
I have a lot of documentation in a readthedocs site, and I'd like to be able to serve it as two separate PDF files. I've separated the contents for each into two top-level *.rst files (formal.rst and informal.rst), specified them both in the…
user2662404
- 59
- 6
0
votes
0 answers
FileNotFoundError while following hyperledger build-your-first-network documentation
Throughout my developing career, I have never asked any questions, so this is my first time :)
I've been reading the docs on hyperledger build-your-first-network and i'm having this error:
ERROR: .FileNotFoundError: [Errno 2] No such file or…
0
votes
1 answer
Sphinx autodoc extension for python > 3.5 docstrings not working because of function argument types
I've been trying to make autodoc automatically document my python 3.7 module. The only file I need to get documented is the init.py file in one single module. That file consists of only functions and has docstrings in the Sphinx format. So far so…
user1460675
- 407
- 4
- 9
0
votes
0 answers
Can we pass JSON format to read the docs?
is there a way to pass JSON to read the docs and it can read and generate a html page with table structure or something of similar sorts?
E.g.
{
"math": [
{
"Type": "A",
"description": "Create A",
…
Akash Palghadmal
- 40
- 5
0
votes
1 answer
Is it possible to generate images and .rst files on build with read-the-docs?
I have a Python package containing a data module with some data in .json format (https://github.com/oemof/tespy/tree/dev/tespy/data). I want to document these data as plots in my online documentation like this…
Francesco Witte
- 1
- 1