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

read-the-docs: ImportError despite dependency being set in setup.py

Consider this build error: I see lines like: ImportError: No module named swisseph and invalid signature for automodule (u'jyotisha\n :members:'). My setup.py does include pyswisseph as a dependency already.. What's a good fix? PS: My local…
vishvAs vAsuki
  • 2,421
  • 2
  • 18
  • 19
0
votes
1 answer

Latest build not being found

I have had my project hooked on Read The Docs for awhile and I am trying to push all my Markdown it now and realizing after verifying the webhooks are active (I imported it by connecting accounts) and rebuilding it I still get the 404 page and I can…
FrickeFresh
  • 1,688
  • 1
  • 19
  • 31
0
votes
1 answer

reStructuredText hyperlinks to source files (C, configurations, ...) working on GitHub and Read the Docs

I would like to create a reStructuredText document providing a hyperlink to a C source file or a OS configuration file hosted on GitHub in the same repo as the documentation. The link would have to bork both on GitHub (pointing to a file in the same…
Iztok Jeras
  • 81
  • 7
0
votes
0 answers

Can't get read the docs working on my github repo

I'm trying to install read the docs in my repo: https://github.com/robocomp/robocomp/tree/highlyunstable I have followed this guide: http://tutos.readthedocs.io/en/latest/source/git_rtd.html But I always end up with this screen: Any idea what am I…
Nicolás González
  • 121
  • 12
0
votes
1 answer

Sphinx autodoc with parameter from a mocked module on readthedocs

We are using readthedocs to document our open source project pandapower. Since pandapower has dependencies to numpy and other C libraries that can't be built on rtd, we use the autodoc_mock_imports parameter to create mock imports for these…
lthurner
  • 75
  • 1
  • 7
0
votes
0 answers

how to present tabs in readthedocs?

can I achieve a nice tab effect as https://spark.apache.org/docs/2.1.0/programming-guide.html#initializing-spark to support multiple languages example?
rio
  • 685
  • 9
  • 16
0
votes
0 answers

returned more than one Version Exception when read other's file

Django Version: 1.8.16 Python Version: 2.7.5 All document is public, you can read all of it even you are not login, but when you login, if you don't have super admin permission, the error message come out Exception Request Method: GET Request URL: …
Chan
  • 1,947
  • 6
  • 25
  • 37
0
votes
2 answers

Readthedocs: Is there a way to autodoc same model functions separately in the one file?

Right now my docs/source has an index.rst that in its doctree imports another file called api.rst. In this api.rst file I would like to autodoc a python module. This module is a .py with many functions not attached to any class, but they are…
Joabe da Luz
  • 1,030
  • 2
  • 18
  • 32
0
votes
1 answer

Build documentation on ReadTheDocs fails on requirement shapely (due to libgeos)

While getting the documentation of a python repository right, I stumpled upon the issue that the package requirement shapely cannot be install on ReadTheDocs (RTD). The log says: Searching for shapely Reading…
gplssm
  • 129
  • 1
  • 7
0
votes
1 answer

ImportError: No module named 'pkg_resources' in builds on readthedocs.org

I started building docs for a project of mine with readthedocs, and it was working great for a while, but now I get this crazy error: Collecting sphinx==1.3.5 Using cached Sphinx-1.3.5-py2.py3-none-any.whl Collecting Pygments==2.1.3 Using cached…
Josh Holbrook
  • 1,611
  • 13
  • 10
0
votes
1 answer

Why is my ReadTheDocs project not importing?

I have had a project that imports and builds on ReadTheDocs for nearly a year. After quite a while without updates, I decided it was time to rebuild the docs. However, the build now fails with a not-very-informative error of: Error: Failed to…
bht
  • 801
  • 8
  • 18
0
votes
1 answer

Error in Hosting ReadTheDocs in house Server in python3

I am trying to install readthedocs in local system (Ubuntu 14.04 ) in python3 virtual env from the instructions given in this link When I ran pip3 install -r requirements.txt , I got an error for Distutils2 . I removed that dependency as the…
Shiva MSK
  • 484
  • 1
  • 6
  • 16
0
votes
1 answer

Read the docs: Build environment creation failed

Read The Docs kept telling me that my documents failed to build. Error log shows that 'Build environment creation failed'. I tried to wipe my build environment, but the documents still failed to build. Here's an image of the page: Build environment…
Garfield550
  • 584
  • 1
  • 8
  • 13
0
votes
1 answer

Readthedocs local installation fails

Installing readthedocs locally following the guidelines from the http://read-the-docs.readthedocs.io/en/latest/install.html fails. I'm attempting to install it on a Mac Pro OSX El Capitan 10.11.15. When I try to reach localhosts:8000 it returns the…
Lex
  • 11
  • 1
0
votes
2 answers

Fresh install readthedocs, connecting to github

I am following this tutorial of how to install readthedocs locally. https://docs.readthedocs.io/en/latest/install.html Everything works as expected, however there is a thing I cannot wrap my head around. I have created user, activated him by…
Drachenfels
  • 3,037
  • 2
  • 32
  • 47
1 2 3
…
36 37