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...

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, b...

I am creating documentation using the Read the Docs theme for Sphinx documentation. I am trying to center the entire webpage - both the body and the left navigation bar, such that if the width of t...

I follow the instructions on read the docs but I get this error: bash Sphinx error: master file /home/docs/checkouts/readthedocs.org/user_builds/mybinders/checkouts/latest/docs/source/contents....

I have open-sourced some of my code, but the documentation won't build properly on ReadTheDocs despite working as expected with the Makefile created by sphinx-quickstart and make html locally. Can ...

I have simply no idea on how can I link to another document in the reST file. I want to link a file named install.rst to my quickstart guide in a paragraph. I don't know how can I achieve this. P...

The problem I am having trouble getting my docs to build successfully when clicking "Build" on the readthedocs.io web interface, but it builds just fine on my local machine. To test that it is an ...

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 s...

The word following "blob" in below URL points to the "master" branch of given repository: https://github.com/celery/celery/blob/master/docs/django/first-steps-with-django.rst As per the above co...

I would like to use ReadTheDocs to host my Sphinx documentation. The project is hosted on github. I can connect to it just fine. The particularity that I have is that the project contains 2 Sphinx...

I'd like to have a link to the automatically generated index in the sidebar when using sphinx-rtd-theme. I've tried adding it to the toctree: .. toctree:: first second Index <:ref:`genindex...

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. S...

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 brin...

I understand the Sphinx supports markdown or .md files optionally, which works great for me for my supplimental documentation. What I am trying to do is use the autoclass or automodule tags in a ma...

I'm already using a custom css to override some of the styles of the theme using def setup(app): app.add_css_file('custom.css') This works fine. What other app. functions are available? I can'...

I'm trying to build documentation on https://readthedocs.org/. I cannot see the docstrings for any files that import matplotlib. When I look into the build log, I see that from matplotlib import ...

I have written the documentation for a medium sized C++ piece of software using Doxygen together with Markdown. I am quite happy with it, as after changing the xml layer I ended up with something l...

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?

I am using read the docs theme to create a HTML content using sphinx. In the theme, I want to edit the hyperlink for "Edit on Github" section. I am able to enable or disable the link usin...

I would like to include the versions.html in the sidebar and could not succeed. I tried to add versions.html in ** for sidebars, this had no effect: html_sidebars = { '**': ['versions.html'] } ...

This happens locally via sphinx running readthedocs theme, it also happens in readthedocs.io. I have added an svg logo (actually it's just the downloaded rtd logo.svg copied from their site for te...

I built a Sphinx documentation and the build works well locally. My docstrings appear as shown below. When moving to readthedoc.io, I added a specific requirement file under docs/requirement.txt w...

On readthecods I am trying to build a project, but I get the error Error Duplicated build. How to fix that problem?

Problem: I have been fighting with Read the Docs. An imported module interacts with I/O, so the documentation does not contain any text. But the build does not fail. Attempted Solution: I am trying...

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...