read-the-docs

问题 Structure The following structure of the project: index.rst MyProject ========= Contents: .. toctree:: group1 group1.rst Group1 ------ Subgroup1 ========= Subgroup1 contents Subgroup2 ========= Subgroup2 contents Rendered to (after clicking on Group1 -> Subgroup2 ): As you can see it opens the Group1 page and linked to Subgroup2 section. Want I want to have the same on the left side ( Group1 openned and Subgroup2 choosed) but on the right side I want to see only Subgroup2 page (page without

问题 Structure The following structure of the project: index.rst MyProject ========= Contents: .. toctree:: group1 group1.rst Group1 ------ Subgroup1 ========= Subgroup1 contents Subgroup2 ========= Subgroup2 contents Rendered to (after clicking on Group1 -> Subgroup2 ): As you can see it opens the Group1 page and linked to Subgroup2 section. Want I want to have the same on the left side ( Group1 openned and Subgroup2 choosed) but on the right side I want to see only Subgroup2 page (page without

问题 Structure The following structure of the project: index.rst MyProject ========= Contents: .. toctree:: group1 group1.rst Group1 ------ Subgroup1 ========= Subgroup1 contents Subgroup2 ========= Subgroup2 contents Rendered to (after clicking on Group1 -> Subgroup2 ): As you can see it opens the Group1 page and linked to Subgroup2 section. Want I want to have the same on the left side ( Group1 openned and Subgroup2 choosed) but on the right side I want to see only Subgroup2 page (page without

问题 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 and obtain the desired output. That is, the Reference Guide part of the documentation contains the API automatically generated using the docstring I have included in my code, and referenced using calls to autoclass and autofunction (reference_guide.rst). For example, here is what the first part of

问题 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 and obtain the desired output. That is, the Reference Guide part of the documentation contains the API automatically generated using the docstring I have included in my code, and referenced using calls to autoclass and autofunction (reference_guide.rst). For example, here is what the first part of

问题 My repo is located on github here: https://github.com/AshleySetter/optoanalysis And the docs are in https://github.com/AshleySetter/optoanalysis/tree/master/optoanalysis/docs ReadTheDocs doesn't fail but the produced documentation (hosted here: https://optoanalysis.readthedocs.io/en/latest/) doesn't display the doc strings that should be produced by the ..autodoc:: command. However it runs fine locally and displays the documentation when I open the build/html/index.html file. On ReadTheDocs

问题 My repo is located on github here: https://github.com/AshleySetter/optoanalysis And the docs are in https://github.com/AshleySetter/optoanalysis/tree/master/optoanalysis/docs ReadTheDocs doesn't fail but the produced documentation (hosted here: https://optoanalysis.readthedocs.io/en/latest/) doesn't display the doc strings that should be produced by the ..autodoc:: command. However it runs fine locally and displays the documentation when I open the build/html/index.html file. On ReadTheDocs

问题 I have this python package that I'd like to automatically document using Sphinx. I've inserted docstrings in every functions and classes. I made an account on ReadTheDocs, and did the setup accordingly (i.e., a docs/ dir with a conf.py file). Then, basically, I've tried almost everything: every combination of autodoc:: , autofunction:: , autoclass:: ; I tried using the same conf.py file as other packages which documented API (with specific changes made according to my case, of course); but it

问题 I have a package I just updated to use setuptools_scm and found the version number is wrong in readthedocs. http://sshuttle.readthedocs.org/en/v0.77/ shows: Version: 0.78.dev0+ng083293e.d20160304 however as version 083293e has the 0.77 tag, the version string should be just 0.77 It looks like readthedocs might be making changes to my source code before building. I have looked at the readthedocs build logs, and it seems to have the correct version at one stage (0.77), however this is before it

问题 Created sphinx project with sphinx-quickstart. Ran "make html" and no errors produced. Pushed all the code to GitHub. I tried to import and build project on Read the Docs, but get the following errors. I haven't problems when using a Mac- it builds and renders the code on Read the Docs. This time I'm using Windows 10. Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/thirddocs/envs/latest/lib/python3.7/site-packages/sphinx/cmd/build.py", line 304, in