k98kurz / autodox

Tool for generating documentation automatically from code annotations, types, and docstrings.
Other
2 stars 0 forks source link

Enhancement: autodox footer with Python version and library version #3

Open k98kurz opened 1 week ago

k98kurz commented 1 week ago

Is your feature request related to a problem? Please describe.

Sometimes differences in Python runtime version will result in different autodox output, but there is no way to tell for sure what the Python version was just by looking at the output.

Describe the solution you'd like

It would be nice to have a "documentation generated by autodox" bit at the end with the Python and library version at the bottom of any markdown generated by the autodox CLI.

Describe alternatives you've considered

Not doing it and hoping that bug reports accurately reflect the actual Python version being used.

Additional context

Would help diagnose issues like the recent one I stumbled across for a second time.