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
0
votes
1 answer

How to activate the RTD flyout menu?

I'm using Sphinx and ReadTheDocs to build the documentation of my project. I want to display several version to my end user so I built several branch in my admin area : But when I'm displaying the doc in my browser…
Pierrick Rambaud
  • 1,726
  • 1
  • 20
  • 47
0
votes
1 answer

Is there a way to add private keys in ReadTheDoc?

I want to host my documentation on ReadTheDoc because.... it's great. Problem my repository use Google Earth Engine as a dependancy. This lib require a manual authentification or an authentification through a private key. Is it possible to use…
Pierrick Rambaud
  • 1,726
  • 1
  • 20
  • 47
0
votes
1 answer

How to control image previews for links to readthedocs/ sphinx page?

Is there a setting I can tweak in conf.py to ensure that image previews are generated for links to my index.html? I think I need to put a link to the image inside: Maybe a setting on one…
Kermit
  • 4,922
  • 4
  • 42
  • 74
0
votes
0 answers

How to set the width at which the layout is switched to mobile layout, in Sphinx theme Read the Docs?

The title is my question and i searched the web and the doc of rtd but may be i did not know for what exactly i am looking because i am not a web-tech specialist. I want to achieve that the toggle to the mobile layout appears earlier, at a wider…
c0d3xD3v
  • 1
0
votes
1 answer

Using GitLab + Read the Docs for documentation on a Private VM: RTD build fails

Background I am a technical writer trying to use Read the Docs to generate documentation for one of our product. As we have a non-disclosure agreement for any publication, I have to host the documentation on a virtual machine for customers with…
ChinaMahjongKing
  • 155
  • 1
  • 7
0
votes
0 answers

Sphinx option to download current page

In the top right of each documentation page, I would like an option for users to download the current file that they are currently viewing. Are there any extensions or conf options that achieve this? EDIT: as seen in JupyterBook
Kermit
  • 4,922
  • 4
  • 42
  • 74
0
votes
1 answer

ReadTheDocs says "Could not add webhook"

The GitHub integration for https://desert.readthedocs.io/en/stable/ was working fine then the GitHub user account (python-desert) was converted to an organization and since then we (myself and the owner) are unable to get the hook re-synced or…
altendky
  • 4,176
  • 4
  • 29
  • 39
0
votes
2 answers

genindex and modindex footer links don't work in readthedocs.io

I have a Python project using Sphinx for docs. I am building the docs remotely on readthedocs.io service. I used sphinx-quickstart and it generated an index.rst file with these links in the footer: Indices and tables ~~~~~~~~~~~~~~~~~~ *…
Anentropic
  • 32,188
  • 12
  • 99
  • 147
0
votes
1 answer

Sphinx readthedocs install directory has different layout than installing on my own machine. How to make them the same?

When I run Sphinx on my machine it installs for example developers/integration.rst into developers/integration.html but on readthedocs it installs it in developers/integration/index.html This makes the use of relative links in any raw commands…
Barry Smith
  • 21
  • 2
0
votes
1 answer

How do I tell ReadTheDocs to build my project packages from a sub-directory?

I have a repository that contains three python packages: a main package, and two addon packages, with shared documentation. Each project is in its own directory, with its own setup.py, as so: Repository Main Project setup.py Addon…
Neil Bradley
  • 1
  • 1
  • 2
0
votes
0 answers

Read The Docs/Sphinx doing weird errors on build

I'm trying to make docs for a python API wrapper that I am making (you can view the docs code here), and when I try to make a build on the read the docs dashboard, I get Running Sphinx v1.8.5 loading translations [en]... done making output…
Teddy Rasmussen
  • 46
  • 1
  • 7
0
votes
1 answer

Some Python modules don't show up on readthedocs.io despite appearing when generating Sphinx docs locally

I'm trying to generate Sphinx documentation for a Python project and host the documentation using Read The Docs. The project code is here. When I run make clean && make html to generate documentation locally the documentation generates and has all…
argosopentech
  • 13
  • 2
0
votes
1 answer

ReadTheDocs robots.txt and sitemap.xml

ReadTheDocs auto-generates a robots.txt and sitemap.xml for projects. Each time I deploy a new minor version of my project (ex. 4.1.10), I hide previous minor versions (ex. 4.1.9). ReadTheDocs adds entries for all versions to sitemap.xml, but hidden…
alexdlaird
  • 1,174
  • 12
  • 34
0
votes
0 answers

Include file without references (or reference prefix)

I have a package documented on ReadTheDocs. I want to include the release notes for the newest release of my software both on the landing page and the dedicated release notes page (with the older versions’ notes) Therefore I have my…
flying sheep
  • 8,475
  • 5
  • 56
  • 73
0
votes
0 answers

What's the difference between a target and a reference (reStructuredText)?

What's the difference between a target and a reference in reStructured Text? I'm trying to understand the reST spec and how hyperlinks work in sphinx, which is surprisingly non-intuitive. Unfortunately, the documentation just says "to be completed"…
Michael Altfield
  • 2,083
  • 23
  • 39
1 2 3
…
36 37