read-the-docs

Build failed: code error for my code in Readthedocs

 ̄綄美尐妖づ 提交于 2020-01-24 19:31:13
问题 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 the following error: Configuration error: There is a programmable error in your configuration file: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/helstrom-quantum-centroid-classifier/envs/latest/lib/python3.7/site-packages/sphinx/config.py", line 368, in

Builds failing on random in readthedocs

淺唱寂寞╮ 提交于 2020-01-24 09:18:07
问题 There seems be an odd problem with Readthedocs. Builds are failing without any apparent reason. On the same commit ID, build failed once and was success later: Failure: https://readthedocs.org/projects/opnfvdocsdemo/builds/4909528/ Success: https://readthedocs.org/projects/opnfvdocsdemo/builds/4911183/ My most recent build is failing too, it only has an extra space from the last successful commit: https://readthedocs.org/projects/opnfvdocsdemo/builds/4915952/ This is happening for multiple

Download HTML as separate pages

六眼飞鱼酱① 提交于 2020-01-21 19:08:49
问题 I'm using Read The Docs for a project. Everything seems to be working well online. However, when I download the HTML for offline use, I find that the documentation is all crammed into a single HTML file (index.html). Is it possible to download the documentation so that it has the same look and feel as the online docs with separate, linked pages? I tried changing the documentation type from the RTD Admin > Settings page between the three options (Sphinx Html, Sphinx HtmlDir, and Sphinx Single

Download HTML as separate pages

做~自己de王妃 提交于 2020-01-21 19:08:44
问题 I'm using Read The Docs for a project. Everything seems to be working well online. However, when I download the HTML for offline use, I find that the documentation is all crammed into a single HTML file (index.html). Is it possible to download the documentation so that it has the same look and feel as the online docs with separate, linked pages? I tried changing the documentation type from the RTD Admin > Settings page between the three options (Sphinx Html, Sphinx HtmlDir, and Sphinx Single

How to freeze the first column and first row in Sphinx

折月煮酒 提交于 2020-01-15 09:42:28
问题 I'm new at working with Sphinx and I know thats Phynx is not predestined for tables but I would like to use it for a documentaion of our survey instruments. Therefore I created a table with different topics that are asked in our questionnaires. Since our survey started in 1984, we have a lot of years to cover. The table looks like this: The years (rows) go on until the recent year and it's going to grow every year When I use the table (in csv format) in Sphynx it doesn't show the whole table,

Using ReadTheDocs to host Sphinx Docs created with Jupyter

倾然丶 夕夏残阳落幕 提交于 2020-01-05 07:02:13
问题 I continue to have failed builds with ReadTheDocs using a github repository with Jupyter notebooks rendered using sphinx and the readthedocs theme. I am able to render these locally, however when I try with RTD, I get the following fail message: I tried placing the nbsphinx.py file in the repository but things still fail. Link to RTD is here: https://readthedocs.org/projects/calculus-notes/ Github repo is here: https://github.com/jfkoehler/calc_docs 回答1: RTD needs to install nbsphinx . To

Using ReadTheDocs to host Sphinx Docs created with Jupyter

不问归期 提交于 2020-01-05 07:02:11
问题 I continue to have failed builds with ReadTheDocs using a github repository with Jupyter notebooks rendered using sphinx and the readthedocs theme. I am able to render these locally, however when I try with RTD, I get the following fail message: I tried placing the nbsphinx.py file in the repository but things still fail. Link to RTD is here: https://readthedocs.org/projects/calculus-notes/ Github repo is here: https://github.com/jfkoehler/calc_docs 回答1: RTD needs to install nbsphinx . To

How to force a file (mp4) to transfer from github to readthedocs

左心房为你撑大大i 提交于 2019-12-24 10:23:59
问题 I have a repository on github: https://github.com/springer-math/Mathematics-of-Epidemics-on-Networks Within it there is a file docs/SIR_2dgrid.mp4 which contains an animation I want to appear in the documentation at readthedocs (specifically at this page: http://epidemicsonnetworks.readthedocs.io/en/latest/Simulation_Investigation.html) Additionally, there is a file docs/Simulation_Investigation.rst which codes that page and tries to refer to that mp4. I've tried lots of variants (attempting

Read the docs not updating with new files

流过昼夜 提交于 2019-12-24 05:01:42
问题 I'm having an issue where ReadTheDocs doesn't appear to be updating with new documentation files. Specifically, we added these files (everything d3 related here) but in ReadTheDocs they don't appear (see [this][4]); What I'd expect to see is this: Here's a screenshot of the correctly built docs Note the "Empirical D3 Wrapper" link, which is in the docs when built locally using "make html" but not evident when built on ReadTheDocs. There aren't any errors in the build log that I can find, and

Why can't I clone a git repo for readthedocs to build the documentation?

会有一股神秘感。 提交于 2019-12-23 17:24:36
问题 I'm trying to import my project code for readthedocs so that it can generate a documentation for me. However, at the stage of cloning the repo, there is already an error: checkout ----- Failed to import project; skipping build. Error ----- Failed to get code from 'http://mydomain/myproject.git' (git clone): 128 That error code indicates, that the repository is private, and I cannot access it without logging in, unless I have my SSH key that enables a secure connection between my computer and