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
80
votes
8 answers

How can I link/reference another reST file in the documentation?

I have simply no idea on how can I link to another document in the reST file. I want to link a file named install.rst to my quickstart guide in a paragraph. I don't know how can I achieve this. Please can you also refer to a great resource from…
Aditya ultra
  • 942
  • 1
  • 8
  • 15
54
votes
3 answers

Build Fail Sphinx Error contents.rst not found

I follow the instructions on read the docs but I get this error: bash Sphinx error: master file /home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents.rst not found Do have to you the read the docs…
Mr Eucalyptus Cartoonster
  • 543
  • 1
  • 4
  • 5
32
votes
2 answers

How to host a privately owned documentation with ReadTheDocs or Sphinx

I am totally new to this thing. Spent a whole day trying to figure out the "most commonly used" approach. What I want to implement is something like readthedocs.org, but for a private customer (and proprietary project). Almost all of the FAQs, blog…
62mkv
  • 1,444
  • 1
  • 16
  • 28
31
votes
2 answers

Change the favicon of the Sphinx Read The Docs theme?

I'm already using a custom css to override some of the styles of the theme using def setup(app): app.add_css_file('custom.css') This works fine. What other app. functions are available? I can't find any documentation. I'm looking for the…
Paul Meems
  • 3,002
  • 4
  • 35
  • 66
26
votes
4 answers

Change the colors of the Sphinx Read The Docs theme?

I'm building documentation for my API library and I'm having readthedocs.io host the documentation, and is backed with Sphinx. I have the Read The Docs theme installed for Sphinx using pip install, and the Read the Docs website currently has the…
falling cat
  • 363
  • 1
  • 4
  • 8
25
votes
1 answer

Read-the-docs build fails with "cannot import name 'PackageFinder' from 'pip._internal.index'"

The build of Sphinx docs on read-the-docs fails with the following error (complete log below): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index'…
Bruno Rijsman
  • 3,715
  • 4
  • 31
  • 61
25
votes
3 answers

How to add Sphinx-generated index to the sidebar when using Read the Docs theme?

I'd like to have a link to the automatically generated index in the sidebar when using sphinx-rtd-theme. I've tried adding it to the toctree: .. toctree:: first second Index <:ref:`genindex`> but this resulted in WARNING: toctree…
VZ.
  • 21,740
  • 3
  • 39
  • 42
21
votes
2 answers

Github Pages with Sphinx generated documentation not displaying HTML correctly

I have been trying to publish a Sphinx generated documentation for our repository on Github pages with the theme provided by readthedocs.org. After a few attempts I managed to get it online by uploading the Sphinx generated HTML files in the…
Raf
  • 323
  • 2
  • 7
21
votes
2 answers

using Doxygen in read-the-docs

I have written the documentation for a medium sized C++ piece of software using Doxygen together with Markdown. I am quite happy with it, as after changing the xml layer I ended up with something like that: …
solernou
  • 235
  • 1
  • 2
  • 9
21
votes
1 answer

Make Read the Docs include autodoc documentation for special-members?

I have a module with two documented global special-members. Running Sphinx locally creates documentation that includes their docs, but Read the Docs doesn't. It uses the built-in type's documentation instead. I have tried both styles: #: and…
Márcio
  • 677
  • 8
  • 15
20
votes
5 answers

Building docs fails due to missing pandoc

The problem I am having trouble getting my docs to build successfully when clicking "Build" on the readthedocs.io web interface, but it builds just fine on my local machine. To test that it is an environment issue, I created a virtual…
keirasan
  • 365
  • 2
  • 6
20
votes
2 answers

Embed external html file using iframe in Sphinx

I'm trying to embed an interactive graph, which is saved as an html file, in a reStructuredText document using iframe: .. raw:: html The html file is in the same directory as my…
shrgm
  • 1,315
  • 1
  • 10
  • 20
19
votes
3 answers

How to add a logo to my readthedocs - logo rendering at 0px wide

This happens locally via sphinx running readthedocs theme, it also happens in readthedocs.io. I have added an svg logo (actually it's just the downloaded rtd logo.svg copied from their site for testing). I've added the settings to conf.py and html…
Joel Marks
  • 211
  • 2
  • 3
18
votes
1 answer

Is it possible to upload sphinx pre-generated html documents into ReadTheDocs site?

I'm having a python-3 project that uses the plot-directive, but this currently not supported by ReadTheDocs. Therefore i want to generate and upload the documents as i would normally do with the PyPi repository, but use the -r option to specify a…
ankostis
  • 8,579
  • 3
  • 47
  • 61
16
votes
3 answers

Removing the view source link when using Read The Docs & Sphinx with ReadTheDocs Theme

Is there any way to remove the "View page source" link from a sphinx generated read the docs theme page? There is a similar question here and it recommends finding the breadcrumbs file, but I can't find one
Psionman
  • 3,084
  • 1
  • 32
  • 65
1
2 3
…
36 37