Skip to main content

Automatic API reference documentation generation for Sphinx inspired by Doxygen

Project description

=======
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
(:doc:`example <autoapi/autoapi>`), 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.org/


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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for autoapi, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size autoapi-1.1.0.tar.gz (67.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page