python-sphinx

问题 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

问题 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

问题 I am currently trying to implement automatic documentation creation with Sphinx (using the extensions sphinx-apidoc and napoleon). This works quite well, but it would be even better if the typehints (PEP484 convention) are added automatically to the params list. I was wondering whether this is possible. More concretely: (from the napoleon example) def function_with_pep484_type_annotations(param1: int, param2: str) -> bool: """Example function with PEP 484 type annotations. Args: param1: The

问题 Problem I have been using (Python) Sphinx doc, along with CommonMark parser, to write Sphinx documentation containing files written in both reStructuredText and Markdown. So far so good, it works really fine (see this line in an example of Sphinx conf.py file). However, CommonMark's support for GitHub flavored Markdown (GFM) is not perfect, and one important feature it lacks are emoji . I searched for other Markdown parser, more specific to GFM, for instance py-gfm, but none of them seem to

问题 Problem I have been using (Python) Sphinx doc, along with CommonMark parser, to write Sphinx documentation containing files written in both reStructuredText and Markdown. So far so good, it works really fine (see this line in an example of Sphinx conf.py file). However, CommonMark's support for GitHub flavored Markdown (GFM) is not perfect, and one important feature it lacks are emoji . I searched for other Markdown parser, more specific to GFM, for instance py-gfm, but none of them seem to

问题 I want to use Sphinx so it can automatically generate a pydoc for my python code but I'm getting an error. What an I doing wrong? conf.py sphinx config file import sys import os from django.conf import settings os.environ['DJANGO_SETTINGS_MODULE'] = '../cloud_server.settings' sys.path.insert(0, os.path.abspath('../cloud_server/cloud_api')) views.py django file from django.contrib.auth.models import User, Group from rest_framework import viewsets from cloud_api.serializers import

问题 I have installed Sphinx in order to document some python modules and class I'm working on. While the markup language looks very nice, I haven't managed to auto-document a python code. Basically, I have the following python module: SegLib.py And A class called Seg in it. I would like to display the docstrings of the class and module within the generated sphinx document, and add further formatted text to it. My index.rst looks like this: Contents: .. toctree:: :maxdepth: 2 chapter1.rst and

问题 I have installed Sphinx in order to document some python modules and class I'm working on. While the markup language looks very nice, I haven't managed to auto-document a python code. Basically, I have the following python module: SegLib.py And A class called Seg in it. I would like to display the docstrings of the class and module within the generated sphinx document, and add further formatted text to it. My index.rst looks like this: Contents: .. toctree:: :maxdepth: 2 chapter1.rst and

问题 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

问题 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