#Name der virtuellen Umgebung Sphinx_Ich werde mit dem Test fortfahren
conda create -n sphinx_test python=3.6

conda activate sphinx_test

pip install sphinx

#Machen Sie den Dokumentordner zu einem Arbeitsbereich
sphinx-quickstart docs

import os
import sys
sys.path.insert(0, os.path.abspath('../'))
#Ich möchte auf die py-Datei verweisen, die sich im obigen Verzeichnis befindet
# os.path.abspath('./') => os.path.abspath('../')

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon'
]

.\docs\make singlehtml

# "."Übersehen Sie es nicht. Bedeutung aller Dateien im Verzeichnis.
sphinx-apidoc -f -o .\docs .

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   TestClass # <-Die Python-Datei, die Sie hinzufügen möchten

- sphinx_test
    - docs
    - TestClass.py <--Leg es hierhin

class TestClass:
    """Summary line.
    """

    def testfunc(self, x, y):
        """sum

        Args:
            x (int): 1st argument
            y (int): 2nd argument

        Returns:
            int: sum result

        Examples:
            >>> print(testfunc(2,5))
            7
        """
        return x + y

.\docs\make singlehtml

Recommended Posts