There is vale.sh for writing better docs and linting them. But is there also a good tool to check if the structure is compatible with some kind of a schema? Like containing specific headings and a minimum amount of words as a description. #documentation #DocAsCode
Wollt ihr mehr über #Methoden, #Vorlagen und #Tools erfahren, die zum Erstellen einer hochwertigen, sich selbst validierenden #Softwaredokumentation eingesetzt werden? Dann hört euch den Vortrag von @sippsack und @dirkmahler auf der #bettercode an. Sie zeigen euch u. a. Ansätze wie #Docs-as-Code, leichtgewichtige Textformate, Ablage in der Versionsverwaltung und die Einbettung in die Build- und Review-Prozesse. 👉
https://archdoc.bettercode.eu/veranstaltung-20915-se-0-lebendige-architekturdokumentation-mit-docs-as-code-jqassistant-und-jmolecules.html
Parlons documentation avec @themr0c, Senior Technical Writer chez Red Hat !
#podcast #IA #nocode #documentation #kubernetes #OpenSource #ansible #freesoftware #rudder #redhat #docascode #antora #fosdem #glpi #obsidian #NoCodeFrance
0.7.1 release of #py2puml 🎉
Several improvements of the generated #PlantUML syntax:
- use the 'namespace' instructions to group and nested datastructure definitions, to illustrate the codebase structure
- complex compound types (like Dict[Tuple[str], List[SomeClasse]]) are handled
Py2puml is a #DocAsCode tool, which generates a class diagram from your #Python app codebase.
- try it out: https://pypi.org/project/py2puml/
- give some feedback (issues and ⭐ are appreciated 🙏): https://github.com/lucsorel/py2puml
✨ 1st release of #pydoctrace 🎉
Trace #Python code execution with a decorator to view the corresponding sequence diagram in #PlantUML syntax.
#DocTracing generates documentation from real-life code execution and illustrates how the codebase is executed and organized. It helps discussing architecture or teaching algorithms. #DocAsCode
- try it out: https://pypi.org/project/pydoctrace/
- give some feedback (issues and ⭐ are appreciated 🙏): https://github.com/lucsorel/pydoctrace
Version 0.6.1 of #py2puml is released 🎉
This #Python library generates the class diagram of the data structures defined in your codebase. This new version handles class having digits in their names.
#DocAsCode helps documenting the codebase, understanding and maintaining it with better insights.
📖 Diagram as Code https://diagrams.mingrammer.com/
> Diagrams lets you draw the cloud system architecture in Python code.