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
How can I create an incoming webhook via ReadTheDocs API?
I am aware that you can create and delete incoming webhooks using the ReadTheDocs UI (for GitHub, GitLab, etc. integration), but I need to be able to do this without accessing the UI to automate the process. Is this possible? Or will webhook…
0
votes
0 answers
Sphinx doesn't respect :widths: attribute for tables (rtd-theme)
I declare a table for sphinx using this syntax:
.. list-table::
:header-rows: 1
:widths: 1 1 2
* - Platzhalter
- Beispiel
- Beschreibung
* -
-
- ...
But Sphinx is just ignoring the widths…
glades
- 3,778
- 1
- 12
- 34
0
votes
1 answer
Documentation keeps showing old version (readthedocs)
I updated my documentation, I even built it from scratch again and uploaded the corresponding "site" files to github, but no matter what I try, only the oldest version of my doc shows up.
For example, in this markdown file, the example should…
Johncowk
- 342
- 1
- 16
0
votes
1 answer
ReadTheDocs fails to clone due to CAfile
I have a project that was being published with no issues to RTD and it is now giving me a clone error all the time. I don't know if it is something that could have changed in my environment on in theirs.
Command git clone --no-single-branch --depth…
guigomcha
- 68
- 2
- 6
0
votes
1 answer
Grid table does not word-wrap
This is a question on Sphinx and read-the-docs. I have the grid table shown below. Can anybody help me because it does not word-wrap? The table becomes much wider than the screen width and it has a horizontal scroll bar. I would like the table to…
Martijn Dirkse
- 543
- 7
- 16
0
votes
1 answer
How to add 'matplotlib' to readthedocs.yaml or requirements.txt?
The scene:
wrote my own python package
used sphinx to create documentation for said package
I'm now trying to upload said documentation to readthedocs
The problem:
When I try to build the documentation, I end up with an error ModuleNotFoundError:…
user2954167
- 155
- 1
- 3
- 14
0
votes
0 answers
Disable search for PR builds in read the docs
I'm having a python project on RTD that takes quite a while to build. Sphinx takes about 8-9 minutes and after that the RTD build sits another 20 minutes on this step before it completes:
The HTML pages are in _build/html.
Updating searchtools for…
FirefoxMetzger
- 2,880
- 1
- 18
- 32
0
votes
1 answer
What is the cause of this Sphinx autodoc MockFinder error?
I am creating documentation with Sphinx. My folder structure looks as follows:
MyProject
├── mypackage
│ ├── __init__.py
│ ├── mycode.py
│ └── etc.
└── docs
├── build
├── make.bat
├── Makefile
└── source
├── conf.py
…
ryanhill1
- 165
- 1
- 9
0
votes
0 answers
python docstring style leaving blank spaces
I'm using docstrings with sphinx for documenting a project. It's working generally fine but as you see in the below image, I'm losing a lot of space in the "parameters" section.
Is there a way to remove that "parameters" while keeping it in the…
Rodrigo A
- 657
- 7
- 23
0
votes
0 answers
Building Sphinx documentation with Breathe, Exhale and Doxygen gives XML error
I am trying to set up the documentation for my C++/Python library, and want to use Sphinx and Read The Docs to do so. Because a large portion of the library will be written in C++, I have to use something like Breathe and Doxygen to access the C++…
Pencilcaseman
- 360
- 6
- 16
0
votes
0 answers
Readthedocs autodoc working in pdf but not html
I'm unable to get autodoc to work with ReadTheDocs. Everything works normally locally, and ReadTheDocs shows no errors in raw view.
Moreover pdf version of the docs looks like I intended with functions documented, while html refuses to include the…
Radost
- 309
- 3
- 11
0
votes
0 answers
Sphinx autodoc for python module doesn't show module doc on readthedocs
I've written and documented a python module which I want to host on ReadTheDocs. I'm using sphinx to generate the docs, and for some reason, even though it works locally, ReadTheDocs does not render the docstrings I've included in the code.
I'm…
omazhary
- 1
- 2
0
votes
1 answer
Syntax highlighting on readthedocs.io of sphinx code-block
I'm using RTD + Sphinx for my project ( redgrease = https://github.com/lyngon/redgrease ) and it seems like the syntax highlighting of code-blocks isn't working on the readthedocs.io page.
It only displays black text in a box.
E.g. see list item 3…
Anders
- 171
- 4
0
votes
1 answer
readthedocs not generating index page properly
Index.rst files look like this.
Modules
==========
Contents:
.. toctree::
:maxdepth: 1
ping
rpc
I have ping.rst and rpc.rst in same directory as index.rst. The html pages for ping and rpc are being created properly but index,html…
rahul
- 13
- 3
0
votes
0 answers
With genindex is it possible to have multiple auto-generated indexes that are scoped to separate chapters?
With the following RST, Sphinx automatically generates one index for the entire documentation.
#####
Index
#####
.. toctree::
:hidden:
genindex
I would like to split the index into multiple indexes based on the chapters of my documentation…
marcel-1
- 1
- 1