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