Skip to content

executablebooks/sphinx-ext-autodoc

Repository files navigation

sphinx-ext-autodoc [IN-DEVELOPMENT]

Code style: black

Auto-document sphinx extensions.

Ths package is intended to analyse a sphinx environment and extract documentable information, regarding the elements loaded by each extension (and docutils/sphinx themselves), such as:

  • roles
  • directives
  • nodes
  • transforms
  • event callbacks

Then optionally turn it into documentation pages (maybe similar to how sphinx-apidoc works).

(package originally created by python-pkg-cookiecutter)

About

Auto-documentation for sphinx extension components

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages