Stack Overflow
Stack Overflow

Questions tagged [read-the-docs]

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.

Links

548 questions
2
votes
1 answer

Sphinx Documentation with different separated subjects

I'm trying to build kind of a dashboard in the index with one tile per subject. Each subject will later have its own folder in source with it's own md files. I want each subject to be disconnected to the others. So the previous button should no go…
vinni
  • 633
  • 2
  • 8
  • 32
2
votes
0 answers

readthedocs autobuild needs Fortran compiler: Upload locally built files instead?

I have a package for which the documentation is produced automatically using Sphinx and readthedocs. When I make html locally it works fine, the local version of the html files can be navigated etc. When I push to git the autobuild of these docs is…
abinitio
  • 609
  • 6
  • 20
2
votes
1 answer

AttributeError: '_NamespacePath' object has no attribute 'sort' on Read the docs

Pretty sure this isn't a dupe. my read docs build fails here: Collecting sphinxcontrib-inlinesyntaxhighlight==0.2 (from -r /home/docs/checkouts/readthedocs.org/user_builds/zproc/checkouts/latest/requirements.txt (line 33)) Using cached…
Dev Aggarwal
  • 7,627
  • 3
  • 38
  • 50
2
votes
1 answer

How can I add Drift JavaScript to a readthedocs site?

This is the site Aviatrix and these are the instructions from Drift. And this is what the readthedocs help says. However I've tried these and it won't appear on the site.
Karla Mariana
  • 21
  • 1
2
votes
1 answer

ReadTheDocs Import Error from __init__.py

I am having trouble with readthedocs autodocs - the build completes but my documentation is empty for each class. Looking at the build information, seem to be getting a Syntax Error which causes a few warning: print(clean_sample,…
isaacsultan
  • 3,784
  • 3
  • 16
  • 29
2
votes
2 answers

How to change the rtd background color?

I would like to change the background color of the Read the Docs theme for sphinx-doc. The theme is written using sass and I find the variable $section-background-color which is defined no-where. If I replace the #2980B9 with another value…
nowox
  • 25,978
  • 39
  • 143
  • 293
2
votes
1 answer

Readthedocs suddenly unable to install scipy

Quite suddenly, readthedocs has become unable to build our project. As far as I can see it's due to scipy 1.0.0, and for some reason it thinks it's running on windows? All builds fail with the error below: Installed…
Michael Clerx
  • 2,928
  • 2
  • 33
  • 47
2
votes
1 answer

Change branch for latest version

I have a new ReadTheDocs installation where the 'latest' version points to the 'master' branch of my GitHub repository. I would like to change the branch to 'development' but have found nothing in the documentation that tells me how to do it. What…
Jonathan
  • 2,635
  • 3
  • 30
  • 49
2
votes
1 answer

Using ReadTheDocs to host Sphinx Docs created with Jupyter

I continue to have failed builds with ReadTheDocs using a github repository with Jupyter notebooks rendered using sphinx and the readthedocs theme. I am able to render these locally, however when I try with RTD, I get the following fail message: I…
jfkoehler
  • 269
  • 2
  • 17
2
votes
1 answer

Readthedocs build: cmake/swig are not available

In order to build in readthedocs, I need to install some requirements. One of these pip requirements needs cmake and swig to build. Is it still possible to use readthedocs in this scenario?
Juan Leni
  • 6,982
  • 5
  • 55
  • 87
2
votes
1 answer

How to use third-party python plugins\extensions?

I've read on the docs that only few plugins are pre-installed in the virtualenv where the build happens. How can I use the read the docs service with custom plugins then? I am using mkdocs to build a little documentation, in the mkdocs.yml…
Maxiride
  • 187
  • 8
2
votes
1 answer

Use custom theme on ReadTheDocs

I try to use a custom theme inherited from Sphinx's built-in ReadTheDocs Theme. When I use it on my local computer I have the good design. But when I am on the read the doc version (imported from github) there is no CSS. Did I miss something? The…
JulienDelRio
  • 23
  • 3
2
votes
1 answer

Bad Sphinx :linenos: alignment

Line numbers are not aligned in Sphinx's Read The Docs Theme. The highlighted lines are 5 and 8. The restructured text which produced this: .. code-block:: python :emphasize-lines: 5, 8 :linenos: Thoughts on why this might be happening?
rmorshea
  • 832
  • 1
  • 7
  • 25
2
votes
1 answer

How do I customize Sphinx RtD Theme default search settings?

How do I override the default Search html that comes with the Sphinx RTD theme. I am on Sphinx 1.5 and the theme is always imported and not static.
veenamj
  • 35
  • 8
2
votes
1 answer

Readthedocs local server stuck on Triggered state during build

I have installed a local instance of Readthedocs server, but anytime I try to build a github repository the app gets stuck in the Triggered state!. There is no errors or exceptions, just regular info messages: [25/Apr/2017 14:21:11] INFO…
Ander
  • 5,093
  • 7
  • 41
  • 70
1 2 3
…
36 37