Une note personnelle pour documenter le code Python à l'aide de Sphinx. Voici un très bel article.
#Nom de l'environnement virtuel sphinx_Je vais procéder au test
conda create -n sphinx_test python=3.6
conda activate sphinx_test
pip install sphinx
#Faire du dossier docs un espace de travail
sphinx-quickstart docs
--Des questions sur les paramètres vont se poser, mais si vous souhaitez conserver les valeurs par défaut, appuyez simplement sur la touche Entrée.
--Ouvrez docs / conf.py
import os
import sys
sys.path.insert(0, os.path.abspath('../'))
#Je veux faire référence au fichier py placé dans le répertoire ci-dessus, alors faites-le
# os.path.abspath('./') => os.path.abspath('../')
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon'
]
.\docs\make singlehtml
# "."Ne l'oubliez pas. Signification de tous les fichiers du répertoire.
sphinx-apidoc -f -o .\docs .
.. toctree::
:maxdepth: 2
:caption: Contents:
TestClass # <-Le fichier python que vous souhaitez ajouter
- sphinx_test
- docs
- TestClass.py <--Mettre ici
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
--Pareil qu'avant
.\docs\make singlehtml
Recommended Posts