8000 GitHub - stefanv/myst-apidoc: Recursively scan a Python module and export numpydoc docstrings to JSON · GitHub
[go: up one dir, main page]

Skip to content

About

Recursively scan a Python module and export numpydoc docstrings to JSON

Resources

Stars

6 stars

Watchers

1 watching

Forks

Latest commit

 

History

12 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

myst-apidoc

Proof of concept API documentation generator for mystmd.

Recursively walk a module, and export numpydoc-format docstrings to JSON.

Refer to the plugin README for usage.

For an example rendering, see: https://github.com/stefanv/myst-apidoc-example

Included here

  • ./fleece: script to extract numpydoc-style docstrings from a Python package
  • ./myst-apidoc-plugin: mystmd plugin to render the JSON output by fleece

About

Recursively scan a Python module and export numpydoc docstrings to JSON

Resources

Stars

6 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages

0