[PYTHON] Sphinx-Memo

Hintergrund

Ich habe diejenigen zusammengefasst, die ich oft in Sphinx verwende und die nicht ohne ein wenig Forschung herauskommen.

Lesen Sie eine externe CSV-Datei

.. csv-table::Beispieldaten
   :file: sample.csv
   :encoding: utf-8
   :header-rows: 1
(Öffnen Sie eine Zeile)

Wählen Sie für sample.csv unter "Speichern unter" in Excel "CSV UTF-8 (durch Kommas getrennt) (.csv)" aus und speichern Sie es. Wenn Sie am Ende nach: Kopfzeilen keine Zeile öffnen, wird diese nicht angezeigt. Legen Sie außerdem die CSV-Datei im selben Verzeichnis wie die Programmdatei ab.

Excel-Bild links, HTML-Bild rechts

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

Siehe das Etikett auf derselben Seite

.. _`foo_label`:

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

=============
Oben auf der Seite:ref:`foo beschreibung<foo_label>`Sehen.

Lassen Sie die nächste Zeile von [.. _foo_label:] wieder offen.

So fügen Sie Ihrer Dokumentation einen Konstruktor hinzu

Standardmäßig wird der Konstruktor nicht zur Dokumentation hinzugefügt.

Fügen wir in conf.py Folgendes hinzu.

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)

Dann wird der Konstruktor nicht übersprungen.

Referenz

[Wie dokumentiere ich mit Sphinxs Autodoc die __init __ (self) -Methode der Klasse? ](So dokumentieren Sie die init- (self) -Methode der Klasse mit dem Autodoc unter https://www.it-swarm.dev/en/python/sphinx?/971302038/) 1. Praxis des umstrukturierten Textes