Erstellen eines Python-Tools zur Dokumentgenerierung, da die Verwendung von Sphinx schwierig ist

Overview Da das Programm in gewissem Umfang wächst, wird es meiner Meinung nach fast unabdingbar sein, Dokumente für Einzelpersonen oder sogar für einige wenige Personen zu erstellen.

Das Tool zur Dokumentenerstellung in Python fühlt sich jedoch nicht sehr gut an.

Es ist Sphinx, was fast der De-facto-Standard ist, aber ertragen sie wirklich solche ** Strafen **? : Denken:

Neuere Python hat Elemente wie Typhinweise und Variablenanmerkungen hinzugefügt, und statische Typprüfungen wie mypy haben das Programmieren von Programmen erheblich vereinfacht.

Die Erstellung von Dokumenten ist jedoch für den Rest meines Lebens nicht einfach ...: cry:

Sogar Cython unterstützt Typhinweise und variable Anmerkungen, aber wenn es um Sphinx geht, ist ** Sphinx-Schnellstart ** nicht mehr schnell.

Ich warte auf jemanden, der es großartig macht, aber es ist schwer herauszukommen, also habe ich beschlossen, es selbst zu machen.

Usage https://github.com/sumeshi/py2markdown

$ python py2markdown.py <SOURCE_DIRECTORY> <DESTINATION_DIRECTORY>

Da das Tool nicht zur Verteilung bereit ist, werde ich warten, bis der ** stärkste Ingenieur 卍 ** es entwickelt, beeinflusst von diesem Artikel.

Ich werde mein Bestes tun, um eine Umgestaltung vorzunehmen, wenn ich eine Pull-Anfrage erhalte.

Demo

https://py2markdown.netlify.com/

Ich habe versucht, py2markdown.py selbst mit diesem Tool in Markdown umzuwandeln. Vuepress wird verwendet, um markdown-> html zu konvertieren.

Vuepress ist im Grunde wie ein Git-Buch, aber es sieht cool aus und ist schön, weil die Komponenten in vue.js angewendet werden.

Issue Eigentlich mache ich keine Syntaxanalyse von Python, aber ich mache Gorigori-Zeichenkettenverarbeitung.

Also ** Natürlich unterstützt es keine Transformationsnotation wie das Schließen von Funktionen **

Da es nur durcheinandergebrachte Methoden mit Nebenwirkungen gibt, möchte ich sie nach Möglichkeit wie einen Funktionstyp schreiben, um die Nebenwirkungen zu verwässern. Da es jedoch ein Rätsel ist, wie stark sie die Leistung beeinflusst, möchte ich sie je nach Ergebnis schnell und schnell um Cythonize oder Rust herum nutzen. ..

Ich wünschte, ich könnte die Quelle des selbst erstellten Systems, das ich in meiner Forschung entwickelt habe, leicht erkennen. Ich habe es in ein paar Stunden mit einem losen Konzept geschafft, aber es fühlte sich überraschend gut an, deshalb würde ich es gerne richtig implementieren. Masu.: Sushi:

Ende

Recommended Posts

Erstellen eines Python-Tools zur Dokumentgenerierung, da die Verwendung von Sphinx schwierig ist
Betreff: Python Lambda ist nutzlos ^ H ^ H ^ H ^ H ^ H Schwer zu bedienen
[Python] Was ist ein Tupel? Erklärt, wie man es benutzt und wie man es benutzt, ohne zu tippen.
[Python] Memo zum Erstellen von Scraping-Tools
[Python] Was ist ein Slice? Eine leicht verständliche Erklärung zur Verwendung anhand eines konkreten Beispiels
Ein Memorandum, weil ich beim Versuch, MeCab mit Python zu verwenden, gestolpert bin
[Python] Es war sehr praktisch, die Python-Klasse für das ROS-Programm zu verwenden.
Verwendung ist und == in Python
Bequem zum Verwenden von Ebenen beim Laden von Bibliotheken auf Lambda
Es ist bequemer, csv-table zu verwenden, wenn Sie eine Tabelle mit Python-Sphinx schreiben
Beurteilen Sie, ob es sich um eine Primzahl handelt [Python]
Wenn Sie eine SSD mit Linux verbinden und einen Dateiserver erstellen, ist es besser, NTFS zu verwenden.
So überprüfen Sie, ob es sich um einen Wörterbuch-Typ (Wörterbuch, Hash) handelt, indem Sie einen oder alle verwenden
Python Hinweis: Was bedeutet es, einen Startwert mit Zufallszahlengenerierung zu setzen?
Mir wurde klar, dass es Unsinn ist, es ohne nachzudenken zu verwenden, weil das Modul praktisch ist
Lassen Sie uns ein Befehls-Standby-Tool mit Python erstellen
Schritte von der Installation von Python 3 bis zur Erstellung einer Django-App
[Python] Informationen zum Erstellen eines Tools zum Anzeigen aller Seiten der Website, die in der JSON-Datei registriert sind und auf denen sie abgefangen wurden
Slack-Benachrichtigung, wenn ein bestimmtes Wort auf Twitter mit Heroku mit Python gemurmelt wird
Ich habe eine Funktion zum Trimmen des Bildes von Python openCV erstellt. Verwenden Sie sie daher bitte.
Ich möchte nicht nach High Para suchen, da es sich um IQ1 handelt (wie man lightgbm_tuner verwendet).
Erstellung von Schabewerkzeugen
Immerhin ist es falsch, mit Python-Subprozess zu katzen.
So geben Sie ein Dokument im PDF-Format mit Sphinx aus
Verwendung der Methode __call__ in der Python-Klasse
[Python] Hinweise beim Versuch, Numpy mit Cython zu verwenden
[Python] Was ein unerfahrener Programmierer vor dem Erstellen eines Tools getan hat
Python-Anfänger versuchte, bei einem IT-Unternehmen zu praktizieren
Verwenden Sie eine Skriptsprache für ein komfortables C ++ - Leben - OpenCV-Port Python zu C ++ -
VIM ist gut zu bedienen - zumindest ein Anfang, um es zu benutzen
[Python] Was ist Pip? Erläutern Sie die Befehlsliste und deren Verwendung anhand aktueller Beispiele
Das Deep Learning-Framework "CNTK" von Microsoft ist jetzt mit Python kompatibel, was die Verwendung erheblich vereinfacht