[PYTHON] Mémo Sphinx

Contexte

J'ai résumé celles que j'utilise souvent dans Sphinx qui ne sortent pas sans un peu de recherche.

Lire un fichier csv externe

.. csv-table::Exemple de données
   :file: sample.csv
   :encoding: utf-8
   :header-rows: 1
(Ouvrez une ligne)

Pour sample.csv, sélectionnez «CSV UTF-8 (séparé par des virgules) (.csv)» dans «Enregistrer sous» dans Excel et enregistrez-le. A la fin, après: header-rows, si vous n'ouvrez pas une ligne, elle ne sera pas affichée. Placez également le fichier csv dans le même répertoire que le fichier programme.

Image Excel à gauche, image HTML à droite

スクリーンショット 2020-08-15 16.23.31.png スクリーンショット2020-08-1516.28.06.png

Reportez-vous à l'étiquette sur la même page

.. _`foo_label`:

===============
foo Methods
....
....
....

=============
En haut de la page:ref:`description foo<foo_label>`Voir.

Encore une fois, laissez la ligne suivante de [.. _foo_label:] ouverte.

Comment ajouter un constructeur à votre documentation

Par défaut, le constructeur n'est pas ajouté à la documentation.

Ajoutons ce qui suit dans conf.py.

def skip(app, what, name, obj, would_skip, options):
    if name == "__init__":
        return False
    return would_skip

def setup(app):
    app.connect("autodoc-skip-member", skip)

Ensuite, le constructeur ne sera pas ignoré.

référence

[Comment utiliser l'autodoc de Sphinx pour documenter la méthode __init __ (self) de la classe? ](Comment documenter la méthode init- (self) d'une classe en utilisant autodoc à https://www.it-swarm.dev/ja/python/sphinx?/971302038/) 1. Pratique du texte restructuré