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
3
votes
1 answer
autodoc directive works locally but not on readthedocs
My repo is located on github here: https://github.com/AshleySetter/optoanalysis
And the docs are in https://github.com/AshleySetter/optoanalysis/tree/master/optoanalysis/docs
ReadTheDocs doesn't fail but the produced documentation (hosted here:…
SomeRandomPhysicist
- 1,531
- 4
- 19
- 42
3
votes
0 answers
How to include documentation from various files into Sphinx/Read The Docs documentation?
I just can't seem to figure that out. I have this kind of library basically (simplified):
Library
|doc
| scripts
| make
| makefiles
| R
| R scripts
| snakemake
| snakefiles
| config
I want comments (docstring or some…
rioualen
- 948
- 8
- 17
3
votes
0 answers
Path to static files in raw HTML
I am trying to add a raw html with a link to a .json file that is located in the _static folder.
.. raw:: html
Chris
- 170
- 2
- 11
3
votes
0 answers
Builds failing on random in readthedocs
There seems be an odd problem with Readthedocs. Builds are failing without any apparent reason. On the same commit ID, build failed once and was success later:
Failure: https://readthedocs.org/projects/opnfvdocsdemo/builds/4909528/
Success:…
FlyingAura
- 1,541
- 5
- 26
- 41
3
votes
0 answers
Read the docs not updating with new files
I'm having an issue where ReadTheDocs doesn't appear to be updating with new documentation files. Specifically, we added these files (everything d3 related here) but in ReadTheDocs they don't appear (see [this][4]); What I'd expect to see is…
Jake Fenton
- 101
- 3
3
votes
4 answers
Add usage help of command line tool to README.rst
I wrote a little command line tool, and want to add the "--help" usage message to the docs.
Since I am lazy, I would like to make the update procedure as simple as possible. Here is what I want to the update workflow to look like:
Update code which…
guettli
- 25,042
- 81
- 346
- 663
3
votes
1 answer
sphinx autodoc for python doesn't show anything (on readthedocs)
I have this python package that I'd like to automatically document using Sphinx. I've inserted docstrings in every functions and classes.
I made an account on ReadTheDocs, and did the setup accordingly (i.e., a docs/ dir with a conf.py file). Then,…
Dominique Makowski
- 1,511
- 1
- 13
- 30
3
votes
0 answers
How to redirect from old branch to new branch documentation at ReadTheDocs?
We are rendering ReadTheDocs (RTD) documentation for a software project hosted at github (in particular, this one).
Recently we have changed our main branch due to internal policies. In the past we used "develop" as main branch. Now, we are unsing…
fgalan
- 11,732
- 9
- 46
- 89
3
votes
0 answers
How to get Read the Docs to generate py-modindex.html?
I'm trying to get Read the Docs to generate the py-modindex.html file. Research into this question lead me to the following setup:
setup.py in the project directory has the following contents, which were the minimum needed to get pytest to work and…
Chuck
- 4,662
- 2
- 33
- 55
3
votes
1 answer
Can I build and host custom HTML pages at Read the Docs?
My program’s documentation is mainly written in Sphinx, but it also includes two custom HTML pages:
an example report produced by the program;
an extended reference on certain features of the program.
These two HTML files are produced by the…
Vasiliy Faronov
- 11,840
- 2
- 38
- 49
3
votes
1 answer
Mock modules and subclasses (TypeError: Error when calling the metaclass bases)
To compile documentation on readthedocs, the module h5py has to be mocked. I get an error which can be reproduced with this simple code:
from __future__ import print_function
import sys
try:
from unittest.mock import MagicMock
except…
paugier
- 1,838
- 2
- 20
- 39
3
votes
3 answers
readthedocs and setuptools scm version wrong
I have a package I just updated to use setuptools_scm and found the version number is wrong in readthedocs.
http://sshuttle.readthedocs.org/en/v0.77/ shows:
Version: 0.78.dev0+ng083293e.d20160304
however as version 083293e has the 0.77 tag, the…
Penguin Brian
- 1,991
- 14
- 25
3
votes
2 answers
How do I override a template on readthedocs?
I recently added sphinx documentation for blowdrycss to readthedocs.
I want to override the layout.html template on readthedocs. My current template override works fine on localhost, but not on readthedocs. The project uses the Alabaster theme which…
nu everest
- 9,589
- 12
- 71
- 90
3
votes
0 answers
Documenting C# Properties with Breathe
I am using Doxygen, Breathe and Sphinx to create some documentation that I want to put on Read the Docs regarding a simple C# library. Initially, my make.bat script was giving me lots of errors, which I realized were due to the use of…
Dan Forbes
- 2,734
- 3
- 30
- 60
3
votes
1 answer
Why can't I clone a git repo for readthedocs to build the documentation?
I'm trying to import my project code for readthedocs so that it can generate a documentation for me. However, at the stage of cloning the repo, there is already an error:
checkout
-----
Failed to import project; skipping build.
Error
-----
Failed…
Michał Szydłowski
- 3,261
- 5
- 33
- 55