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
9
votes
1 answer
Adding files in subfolders to sphinx documentation (sphinxcontrib-matlabdomain)
I have a directory containing various folders, with each of them having matlab source files in them. Some of these folders have sub-folders containing matlab source files.
How can I create a TOC tree with Sphinx to contain the sub-folders in a…
user3709710
- 131
- 1
- 5
9
votes
1 answer
Mock with submodules for ReadTheDocs
I'm trying to document a Python project with ReadTheDocs. Initially, the build process would die when it got to:
from osgeo import gdal, osr
I've read the rtd faq and used mock for the osgeo module that was giving me trouble. Now the build process…
jkibele
- 408
- 4
- 12
9
votes
2 answers
Multiple Levels of Toctree's in Python-Sphinx
I'm trying to use sphinx in a way to document multiple "levels" of documentation, eg:
Api Reference
Manual
Tutorials
Etc.
The idea is that the Table of Contents is shown on the sidebar relative to the section you're in. So when you're on the main…
Naatan
- 3,424
- 4
- 32
- 51
8
votes
3 answers
What does "blob" in Github correspond to?
The word following "blob" in below URL points to the "master" branch of given repository:
https://github.com/celery/celery/blob/master/docs/django/first-steps-with-django.rst
As per the above convention, what does the following URL point…
Jai Sharma
- 713
- 1
- 4
- 17
8
votes
1 answer
Sphinx - reference to an image from different locations
I am using Python Sphinx (via ReadTheDocs).
I have a repository which contains a few sub-modules, and I'm trying to create a unified documentation, but still keep the the docs assets in each module separately.
My folder hierarchy is:
MyProject
…
ShaharA
- 860
- 8
- 19
8
votes
2 answers
use a private git repository with read the docs
I installed read-the-docs to produce documentation starting from projects on a private git repository which needs user/password authentication.
When import manually a project, how can I put user and password to allow read-the-docs to clone the…
Max
- 121
- 1
- 3
- 6
8
votes
1 answer
Why is toctree not updating with RTD theme?
I have an programmatically generated sphinx-doc source that uses the Read-The-Docs theme. The source tree looks like:
source
├── conf.py
├── index.rst
├── models
│ ├── 1lin
│ │ ├── 1lin_Amplero.rst
│ │ ├── 1lin_Blodgett.rst
│ │ ├──…
naught101
- 18,687
- 19
- 90
- 138
8
votes
2 answers
How to set up multiple Sphinx documents in one project in ReadTheDocs?
I would like to use ReadTheDocs to host my Sphinx documentation. The project is hosted on github. I can connect to it just fine.
The particularity that I have is that the project contains 2 Sphinx documents (e.g. a programmer's manual and a user's…
Kathleen Labrie
- 81
- 1
- 5
8
votes
1 answer
ImportError: No module named for my code on Readthedocs
I am trying to link my Sphinx documentation with ReadtheDocs. I can build the documentation locally but when I try to have ReadtheDocs automatically generate the documentation I get the following error:
Sphinx Standard Error
Making output…
Dave
- 2,849
- 4
- 28
- 20
7
votes
1 answer
How to make a Read the Docs Project Version Public again
A few weeks ago, I made one of the RTD documentation versions I'm working on private, because that version was still in alpha state. Now is the time to make the documentation public again, because we are getting that version ready for release
For…
Steven
- 166,672
- 24
- 332
- 435
7
votes
1 answer
Sphinx: Exclude Next and Previous Buttons
I'm looking to remove the Next and Prev button. From what I read from the doc, this can be achieved by excluding the relations.html; however I am not sure how would one go about achieving that.
I have tried to add the following to conf.py, without…
Stanley
- 139
- 8
7
votes
1 answer
How to Mock Import for Read the Docs?
Problem:
I have been fighting with Read the Docs. An imported module interacts with I/O, so the documentation does not contain any text. But the build does not fail.
Attempted Solution:
I am trying to use mock or MagicMock in doc/conf.py but it…
Brian LaVallee
- 134
- 7
7
votes
1 answer
How can I link the generated index page in ReadTheDocs navigation bar?
I'm creating my documentation with Sphinx on ReadTheDocs, using their theme. The build process generates a genindex.html file, which can be referenced with:
Link to the :ref:`genindex` page.
which creates:
Link to the Index page.
I can't add…
Paebbels
- 15,573
- 13
- 70
- 139
7
votes
2 answers
How to add a copy button in the code blocks for RST/Read the Docs
I have been working on a personal "how-to" guide, chronicling and keeping a journal of my studies as I go along.
I now have a, almost too long block of code that, when I've encountered this length of code myself, its always frustrating trying to…
jpartain89
- 71
- 1
- 5
7
votes
1 answer
Can I use external themes with MkDocs on readthedocs.org?
I switched from the included ReadtheDocs theme to the bootswatch United theme for my project. I did a pip install mkdocs-bootswatch for this theme, and changed theme: readthedocs to theme: united in my mkdocs.yml file.
However, although the project…
AnnB
- 73
- 4