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

Mock import of ctypes fails with unsupported operand on Read The Docs

I have small Windows module that relies on the ctypes core module. On the project RTD site the page for the module comes up empty. Looking at the latest almost successful build log https://readthedocs.org/builds/apt/2900858/ there is a failure…
matt wilkie
  • 17,268
  • 24
  • 80
  • 115
3
votes
1 answer

Password protect readthedocs.org documentation

I have a documentation managed on readthedocs.org. Is there a way to password protect or at least make our documentation available only for some of our customers?
poiuytrez
  • 21,330
  • 35
  • 113
  • 172
3
votes
0 answers

How to display a sidebar TOC for all parts in Sphinx

Maybe it is just me, but I often have a hard time to understand and navigate Sphinx based documentation, because the Table Of Contents only shows the structure of the current page (in the standard themes at least). There is also a previous and…
mar10
  • 14,320
  • 5
  • 39
  • 64
3
votes
1 answer

Changing localhost to public IP in a VM

I am testing RTD to build our API docs implementation, so running a local installation of RTD in a virtualenv within a debian VM. The ./manage.py runserver command runs the RTD server successfully. Validating models... 0 errors found March 25, 2015…
MonamiB
  • 51
  • 6
3
votes
2 answers

Using Google Analytics in readthedocs.org

My project documentation is hosted on readthedocs.org at http://nsetools.readthedocs.org Is it possible to use google analytics with documents hosted on readthedocs? Since html is not generated by me, I am not sure where to apply the google…
Vivek Jha
  • 1,520
  • 3
  • 16
  • 26
3
votes
1 answer

Setting Up Apache Solr on Local Instance of readthedocs.org

Link to Instructions I am following the instructions at http://read-the-docs.readthedocs.org/en/latest/install.html#solr-search-setup Question Currently, I am able to set up a local instance of readthedocs.org; however, I cannot set up search…
jab
  • 5,673
  • 9
  • 53
  • 84
2
votes
0 answers

Exact redirects -- what happens if I now add a custom domain?

I wanted to check something before I break everything. It may be obvious to you, but I'm naturally cautious and wanted to see whether I'm OK to do what I'm thinking. I currently have docs on RTD (and have had them there for 3 years). We have moved…
stichbury
  • 23
  • 4
2
votes
0 answers

Sphinx recursive autosummary not importing modules

I'm going crazy with Sphinx's recursive autosummary. My working directory is: my_wd | |-- docs | |-- source | |--index.md | |--conf.py | |-- _templates | |-- custom-module-template.rst | |--…
sato
  • 768
  • 1
  • 9
  • 30
2
votes
1 answer

How to remove "Built with Sphinx using a theme provided by Read the Docs." from RTD theme built docs?

How can I remove the sentence that's shown underneath each page that's built using RTD theme: "Built with Sphinx using a theme provided by Read the Docs." It's my understanding that the RTD theme is released under MIT license. My project has one…
bad_coder
  • 11,289
  • 20
  • 44
  • 72
2
votes
0 answers

Manage document versions in Readthedocs

I am having hard time understanding Read the Docs version control for my documentation (may be because of lack my understanding!). All my project documents are hosted on GitHub and I am trying to setup versions for my document that needs to be…
Sushivam
  • 2,537
  • 4
  • 15
  • 25
2
votes
1 answer

Sphinx Documentation (autodoc) not working after uploading to Github

I have built sphinx documentation for my package. It is working fine when testing localhost. But after uploading it to Github and building docs on readthedocs.org the documentation page is not working which uses autodoc. Here is the link to the…
Spark Drago
  • 55
  • 6
2
votes
2 answers

Error when running pip install -r requirements.txt

to build and run a local instance, im following the tutorial at https://haha.readthedocs.io/en/latest/install.html but i use the git repo https://github.com/readthedocs/readthedocs.org.git instead of https://github.com/rtfd/readthedocs.org.git for…
user4302
  • 45
  • 7
2
votes
1 answer

Why does RTD run "python env create" instead of "conda env create" when building?

I have a project on ReadTheDocs that I'm trying to build. I'm using a very basic .readthedocs.yaml file that reads: # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for…
esennesh
  • 21
  • 1
  • 3
2
votes
1 answer

Readthedocs adding html_logo causes type error

I have some documentation deployed on readthedocs.io. It was working fine until I added the following line to my conf.py: html_logo = '_static/logo.png', As soon as I try to build the project on readthedocs it fails with the following…
Computroniks
  • 85
  • 1
  • 11
2
votes
1 answer

How to import Markdown with Sphinx and myst-parser into Readthedocs?

In my docs/source/conf.py I have this code: extensions = [ "sphinx.ext.autodoc", "myst_parser", ] source_suffix = ['.rst', '.md'] All my files are in Markdown, not in reStructuredText. On ReadTheDocs, the initial build was successful…
ljyip
  • 41
  • 5
1 2 3
…
36 37