ClammingPy - Light Python-API Documentation in Markdown and HTML
Brigitte Bigi · HAL (Le Centre pour la Communication Scientifique Directe) · 2024
Python modules are usually documented using docstrings. They typically use plain text markup formats such as reStructuredText (reST, the markup used for writing the official Python documentation) and/or Markdown. ClammingPy is a Python, free, open-source, self-hosted library to export a Python class or module into a Markdown and/or HTML files, for documentation purpose. Contrariwise to other documentation tools, docstrings are analyzed with flexibility rather than completeness...ClammingPy generates HTML-5 with high level of WCAG 2.1 conformity.