Créer un outil de génération de documents Python car il est difficile d'utiliser sphinx

Overview À mesure que le programme se développera à une certaine échelle, je pense qu'il deviendra presque essentiel de créer des documents pour des particuliers ou même pour quelques personnes.

Mais l'outil de génération de documents de Python ne se sent pas très bien.

C'est le sphinx, qui est presque la norme de facto, mais endurent-ils vraiment de telles ** pénalités **? : en pensant:

Python récent a ajouté des éléments tels que les indices de type et l'annotation de variable, et la vérification de type statique telle que mypy a rendu les programmes de programmation beaucoup plus faciles.

Cependant, la génération de documents n'est pas facile pour le reste de ma vie ...: pleurer:

Même Cython prend en charge les indices de type et l'annotation de variable, mais lorsqu'il s'agit de sphinx, ** sphinx-quickstart ** n'est plus rapide.

J'attends quelqu'un de formidable pour le faire, mais c'est difficile de sortir, alors j'ai décidé de le faire moi-même.

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

$ python py2markdown.py <SOURCE_DIRECTORY> <DESTINATION_DIRECTORY>

L'outil n'étant pas prêt pour la distribution, j'attendrai que le ** ingénieur le plus fort 卍 ** le développe, influencé par cet article.

Je ferai de mon mieux pour refactoriser si j'obtiens une pull request.

Demo

https://py2markdown.netlify.com/

J'ai essayé de convertir py2markdown.py lui-même en markdown avec cet outil. Vuepress est utilisé pour convertir markdown-> html.

Vuepress est fondamentalement comme un livre git, mais il a l'air cool et c'est bien parce que les composants sont appliqués dans vue.js.

Issue En fait, je ne fais pas d'analyse syntaxique de Python, mais je suis en train de traiter les chaînes de caractères gorigori.

Donc ** Bien sûr, il ne prend pas en charge la notation de transformation comme la fermeture de fonction **

Puisqu'il n'y a que des méthodes foirées avec des effets secondaires, j'aimerais l'écrire comme un type de fonction si possible pour diluer les effets secondaires, mais comme c'est un mystère à quel point cela affecte les performances, en fonction du résultat, je veux l'obtenir rapidement et rapidement autour de Cythonize ou Rust. ..

J'aurais aimé voir facilement la source du système que je développais moi-même dans mes recherches. Je l'ai fait en quelques heures avec un concept lâche, mais c'était étonnamment bon, donc j'aimerais bien l'implémenter. Masu: Sushi:

fin