read-the-docs Questions

2

I'm trying to automatically import a project from Github into ReadtheDocs. When creating the documentation it is failing due to a missing dependency. I've tried adding the setup.py installation in ...
Deathless asked 7/9, 2019 at 15:43

2

Solved

I have been trying to publish a Sphinx generated documentation for our repository on Github pages with the theme provided by readthedocs.org. After a few attempts I managed to get it online by uplo...
Anastaciaanastas asked 28/6, 2020 at 17:39

2

Solved

What I considered: github offers github pages to host documentation in either a folder on my master branch or a dedicated gh-pages branch, but that would mean to commit build artifacts I can also ...

4

Solved

I'm building documentation for my API library and I'm having readthedocs.io host the documentation, and is backed with Sphinx. I have the Read The Docs theme installed for Sphinx using pip install,...
Whisker asked 28/6, 2017 at 4:43

1

I have a basic ReadTheDocs repository. As per the advice of the build page, I sought to use a .readthedocs.yml to configure it: Configure your documentation builds! Adding a .readthedocs.yml fil...
Superposition asked 23/2, 2020 at 17:17

1

Solved

How can I replace the View page source hyperlink at the top of my docs pages with a Edit on GitHub link when building a Sphinx site using the sphinx_rtd_theme theme? I'm manually building a readthe...
Tertullian asked 14/7, 2020 at 21:19

1

Solved

I'm working on my RTFM Documentation and I d'like to change the html-title. Currently, my title looks like this: <title>[PAGE TITLE] — My Documentation documentation</title> Everyth...
Beaufert asked 3/6, 2020 at 14:40

3

Solved

Is there any way to remove the "View page source" link from a sphinx generated read the docs theme page? There is a similar question here and it recommends finding the breadcrumbs file, but I c...
Forbid asked 17/1, 2018 at 7:59

2

I have been working on a personal "how-to" guide, chronicling and keeping a journal of my studies as I go along. I now have a, almost too long block of code that, when I've encountered this lengt...
Fideicommissum asked 28/8, 2016 at 1:21

6

Solved

I have SVG image file with several nodes each is associated with URL. If I open this file directly in browser I can click on each node and it will open different URLs. However when I use this pictu...
Slipnoose asked 13/1, 2016 at 22:2

1

Solved

The build of Sphinx docs on read-the-docs fails with the following error (complete log below): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/read...
Proctoscope asked 21/1, 2020 at 17:10

0

I am trying to link my Sphinx documentation with Readthedocs. I can build the documentation locally in my computer but when I try to have Readthedocs automatically generate the documentation I get ...
Marcelina asked 21/1, 2020 at 4:55

1

Solved

I am building documentation with Sphinx-RTD. I want to have a link somewhere, and be styled as a verbatim or preformatted text. For example, say I have this verbatim: ALTER TABLE Is there a way...
Vociferance asked 23/11, 2019 at 10:40

2

I am totally new to this thing. Spent a whole day trying to figure out the "most commonly used" approach. What I want to implement is something like readthedocs.org, but for a private customer (and...
Jessie asked 30/6, 2016 at 10:20

3

Solved

Is it possible to hide the sidebar when using Sphinx with the ReadTheDocs theme? Extending the question a bit more, can I have it include the sidebar when issuing a command: $ make html and n...
Eelpout asked 13/11, 2017 at 6:17

3

Solved

I'm trying to find out how to use the _template overrides option in Sphinx to override the default ReadTheDocs theme for hosting Sphinx documentation on http://readthedocs.org. Specifically, I'm w...
Padget asked 15/3, 2016 at 18:49

1

Solved

I have followed the instructions on https://docs.readthedocs.io/en/stable/webhooks.html and added a webhook to github to trigger my readthedocs built, however readthedocs rejects the payload: Resp...
Tahsildar asked 2/4, 2019 at 12:52

1

I have followed the getting started guide on Readthedocs and have used Sphinx using autodoc to create the documentation for my Python package on https://github.com/akdiem/bloodflow. (documentation ...
Crappie asked 4/10, 2018 at 13:29

2

I installed read-the-docs to produce documentation starting from projects on a private git repository which needs user/password authentication. When import manually a project, how can I put user a...
Assizes asked 24/10, 2017 at 9:59

1

I am using Python Sphinx (via ReadTheDocs). I have a repository which contains a few sub-modules, and I'm trying to create a unified documentation, but still keep the the docs assets in each module...
Stafford asked 2/9, 2018 at 15:20

1

I have a directory containing various folders, with each of them having matlab source files in them. Some of these folders have sub-folders containing matlab source files. How can I create a TOC t...
Purlieu asked 2/11, 2015 at 20:37

0

I am trying to add read the docs to view our github hosted project's documentation. The project is Calour - an interactive heatmap analysis program for microbiome experiments. We have a large set ...
Crossruff asked 10/5, 2018 at 11:27

1

Solved

I'm getting started with readthedocs.{org,io} and created a project in error that I'd now like to delete. I've looked at the various things I can do to a project and am not seeing any buttons label...
Impersonalize asked 2/1, 2018 at 14:46

1

I'm looking to remove the Next and Prev button. From what I read from the doc, this can be achieved by excluding the relations.html; however I am not sure how would one go about achieving that. I ...
Devest asked 21/2, 2017 at 5:13

1

Solved

I have a small app project on github which runs on Windows and requires pythonnet. My requirement.txt contains: beautifulsoup4==4.6 pythonnet==2.3 Now I thought I would build a documentation f...
Blackfellow asked 12/1, 2018 at 10:49

© 2022 - 2024 — McMap. All rights reserved.