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

Readthedocs / Sphinx not rendering bullet list from rst file

I have a set of rst files that I am building in readthedocs with sphinx. The files have multiple bullet lists, but they are not being rendered correctly. The text appears, but there are no bullet symbols or nesting / indentation. To make sure it was…
FlyingTurbine
  • 323
  • 2
  • 9
15
votes
2 answers

Using github actions to publish documentation

What I considered: github offers github pages to host documentation in either a folder on my master branch or a dedicated gh-pages branch, but that would mean to commit build artifacts I can also let readthedocs build and host docs for me through…
Arne
  • 17,706
  • 5
  • 83
  • 99
15
votes
6 answers

Insert clickable SVG image into Sphinx documentation

I have SVG image file with several nodes each is associated with URL. If I open this file directly in browser I can click on each node and it will open different URLs. However when I use this picture in my Sphinx documentation it doesn't work -…
user2288008
15
votes
3 answers

How do I set up custom styles for reStructuredText, Sphinx, ReadTheDocs, etc.?

I want to extend the theme used by Sphinx and ReadTheDocs with my own custom styles. What is the best way I can do this so that my changes will stick?
zerobandwidth
  • 1,213
  • 11
  • 18
15
votes
2 answers

Show entire toctree in Read The Docs sidebar

It's my understanding the new Read The Docs theme generates the sidebar from the toctree with a depth of 2. My documentation is relatively deep, and a depth of 2 is not enough for it to be useful. How can I increase this limit, or preferably…
Kevin
  • 28,963
  • 9
  • 62
  • 81
14
votes
1 answer

Sphinx: Linking to Embedded Binary Files (PDFs)

I'm using sphinx and RST to generate some tech documentation as HTML and having issues getting a local PDF reference to work as a hyperlink. I've seen people use :download: to link to local PDFs, but I'm embedding the PDFs inside a /docs directory…
SliverNinja - MSFT
  • 31,051
  • 11
  • 110
  • 173
13
votes
3 answers

Sphinx Read-The-Docs Theme recognised but not "found"

I downloaded the read-the-docs theme for sphinx from Github and put it into the _themes folder. conf.py: html_theme = "sphinx_rtd_theme" html_theme_path = ["_themes", ] However, running "make html" I get this error: Sphinx v4.1.2 in Verwendung Lade…
glades
  • 3,778
  • 1
  • 12
  • 34
12
votes
2 answers

How to pre-process source files while a Sphinx run?

I have set up a Sphinx documentation for my project and would like to extract doc strings for the source files and embed them into the final documentation. Unfortunately, the source file's language (VHDL) is not supported by Sphinx. There seems to…
Paebbels
  • 15,573
  • 13
  • 70
  • 139
12
votes
1 answer

How to make toctree link refer to the separate file like it refers to the subsections

Structure The following structure of the project: index.rst MyProject ========= Contents: .. toctree:: group1 group1.rst Group1 ------ Subgroup1 ========= Subgroup1 contents Subgroup2 ========= Subgroup2 contents Rendered to (after…
user2288008
11
votes
1 answer

use the same README content in sphinx and github - relative links

I'm adding a Read The Docs page for my project. For now, I want the same content on my Read The Docs homepage as in my README. My docs/index.rst file looks like: .. include:: ../README.rst .. toctree:: :maxdepth: 2 :caption:…
jtpereyda
  • 6,987
  • 10
  • 51
  • 80
11
votes
2 answers

Read The Docs not working with automodule

I've written some documentation for my project (in the Python docstrings), and tested everything with Sphinx on my local computer – everything works fine, all the import work correctly and so on. So I set up a custom environment on Read The Docs…
George Oblapenko
  • 878
  • 1
  • 10
  • 23
10
votes
2 answers

Python Sphinx autodoc not rendering on readthedocs

I have a Python package hosted on Github called spike2py. I have prepared my docs using Sphinx and .rst files. These files are hosted on GitHub here. I am able to successfully run make html locally and obtain the desired output. That is, the…
Martin Héroux
  • 145
  • 2
  • 10
10
votes
2 answers

Using Sphinx to automatically generate a separate document for each function

I've been building a Python module with many different functions. I'm using Sphinx and readthedocs to provide documentation. I've made decent progress, but currently I have one massive page that gives the documentation for all of my functions (in…
Joel
  • 22,598
  • 6
  • 69
  • 93
9
votes
2 answers

How to find the PDF version of a Read-the-docs project

What am I not seeing? The RTD features page says: PDF Generation When you build your project on RTD, we automatically build a PDF of your project’s documentation. We also build them for every version that you upload, so we can host the PDFs of…
xtian
  • 2,765
  • 7
  • 38
  • 65
9
votes
3 answers

How to redirect readthedocs web pages to other website

We started having our project's docs on readthedocs site (say http://abc.readthedocs.org). For various reasons we now moved to our own web servers with new domain (http://abc.io). We want to bring down http://abc.readthedocs.org gracefully so that…
Sandeep
  • 341
  • 1
  • 9
1
2
3
…
36 37