As a package repository grows, it can be challenging to stay on top of what's there. Writing documentation for a package is great, but how do you expose it to the user?
Implementation
Generate documentation from a package repository, using the contained package data as a foundation, with additional support for docstring, comments on variables and a syntax for executable examples.
"""I'll be written as a summary of this package
And this longer section is made into a description. Very much like Sphinx/Napoleon.
Attributes:
name (str): Name of package
version (str): A version number
commands (callable): ...
"""
name = "my_package"
version = "1.0"
Goal
Generate a HTML or Markdown package summary.
Related
Motivation
As a package repository grows, it can be challenging to stay on top of what's there. Writing documentation for a package is great, but how do you expose it to the user?
Implementation
Generate documentation from a package repository, using the contained package data as a foundation, with additional support for docstring, comments on variables and a syntax for executable examples.