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
2 answers

How to show redundant docs on multiple pages in read the docs

In our read the docs project we have a use case where we need to show some specific docs on multiple pages in the same version of docs. As of now, we do this either by one of the following ways Copy-pasting the content to each page's rst file Write…
Mukund Jalan
  • 1,145
  • 20
  • 39
0
votes
1 answer

ReadTheDocs set version to active via script

I am trying to set ReadTheDocs.com (i.e. the commercial end of ReadTheDocs) versions' active state programatically. This idea being that a branch, when created, has documentation built for it, and when the branch ends we delete the version…
Daniel
  • 11
  • 3
0
votes
1 answer

readthedocs build failing using aiohttp

First time using readthedocs. Firstly, is there a way to specify build with python 3.6? My lastest build is here: https://readthedocs.org/projects/cfanalytics/builds/6772697/ which uses python 2.7 for the build, but my project requires python >=…
Ray Bell
  • 1,508
  • 4
  • 18
  • 45
0
votes
1 answer

Read the docs does not generate method documentation

I created a python library which depends on pypiwin32 package. For some functionality, they use _winreg package. It works on Windows, however RTD virtualenv is not running on Windows and this package is not available. Since it is part of python…
Lorin
  • 137
  • 1
  • 7
0
votes
1 answer

Deploy readthedocs on production (nginx + gunicorn)

I am trying to deploy to a production server the project Read The Docs (http://docs.readthedocs.io/en/latest/install.html) for internal use at the company I work. I followed the install steps at the above url, it worked when I run with 'python…
RLott
  • 330
  • 4
  • 12
0
votes
1 answer

Readthedocs builds with outdated version of code

When running autodoc in Read-The-Docs, it fails with this error for my project: Compiling sources ...error: [Errno 2] No such file or directory: 'gfortran' I have learned that gfortran is not available in RTDF, so I wanted to try avoiding the…
Amos Egel
  • 937
  • 10
  • 24
0
votes
2 answers

why are the arrows missing on the read thod docs theme

I've created documentation using Sphinx and the read the docs theme, but the arrows are missing from the buttons Can anyone help?
Psionman
  • 3,084
  • 1
  • 32
  • 65
0
votes
1 answer

Read The Docs ImportError

For a long time I can not find the right way. I always get a mistake. I have already tried all the paths listed below. os.path.abspath sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(".")))) sys.path.insert(0,…
khashashin
  • 1,058
  • 14
  • 40
0
votes
1 answer

ReadTheDocs Theme folderstructure using Sphinx

I want to create a digital version of my lecture notes. I installed sphinx and changed the config.py file such that the ReadTheDocs theme is working. I want to have a similar structure like in the following screenshot (from the Read the Docs…
MrYouMath
  • 547
  • 2
  • 13
  • 34
0
votes
1 answer

read the docs does not render API automatically

I am really struggling to produce an API automatically on read-the-docs. Here is the library: https://github.com/apatlpo/qgsolver The conda environment is described on the README.md The doc is found…
AurelienJ
  • 53
  • 7
0
votes
0 answers

Build Read The Docs documentation from docs folder created with sphinx

I have made a python package (https://github.com/gee-community/gee_tools) that depends entirely on Google Earth Engine Python API. Although the earthengine-api package is locally installed, to get full and real access to objects you need to…
Rodrigo E. Principe
  • 1,281
  • 16
  • 26
0
votes
1 answer

PDF/html/epub downloads doesn't update for either latest or (manually triggered) stable build

In my project, http://lacinia.readthedocs.io/en/latest/, the downloads (PDF, epub, single-page HTML) doesn't update on a build. It looks like it builds, but the download link keeps downloading a version from Oct 03. I've done some significant work…
Howard M. Lewis Ship
  • 549
  • 4
  • 7
0
votes
1 answer

ReadTheDocs Sphinx Build Failing but working locally

as the title says, building the docs for my package works locally fine but not on the server. I get the following error: Traceback (most recent call last): File…
romeasy
  • 260
  • 1
  • 3
  • 12
0
votes
1 answer

Mock out dependency of a dependency

Imagine the following scenario: You have a python package named 'foo' that depends on 'bar'. The package 'bar' itself depends on another python package, let's say shapely, that depends on a C library that cannot be installed on readthedocs.io.…
gplssm
  • 129
  • 1
  • 7
0
votes
0 answers

Builds on RTFD.io: Latest passes, stable fails

Whenever documentation should get updated on RTFD.io, two builds are built: stable and latest. For weeks now, my latest builds without problem, but the stable does not how. How can my stable fail while my latest builds? The error that occurs is an…
MERose
  • 4,048
  • 7
  • 53
  • 79
1 2 3
…
36 37