Automatic Python API reference documentation generator for Sphinx, inspired by Doxygen.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
examples
lib/autoapi
test
.editorconfig
.gitignore
LICENSE
MANIFEST.in
README.rst
requirements.dev.txt
requirements.txt
setup.py
tox.ini

README.rst

autoapi

Automatic Python API reference documentation generator for Sphinx, inspired by Doxygen.

AutoAPI is a Sphinx extension that allows to automatically generate API reference documentation for Python packages, recursively, without any intervention from the developer. It will discover all the package modules and their public objects and document them.

Documentation

https://autoapi.readthedocs.io/

License

Copyright (C) 2015 Carlos Jenkins <carlos@jenkins.co.cr>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.