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.

Source Distribution

autoapi-1.1.0.tar.gz (67.5 kB view details)

Uploaded Source

File details

Details for the file autoapi-1.1.0.tar.gz.

File metadata

  • Download URL: autoapi-1.1.0.tar.gz
  • Upload date:
  • Size: 67.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for autoapi-1.1.0.tar.gz
Algorithm Hash digest
SHA256 fd7a4e58a7d285ea1de5bbbc9461064cd54dc04a2e06cc117d8e42c94fbc3240
MD5 67b185c4dcede6506f55dbbfaaea2af7
BLAKE2b-256 a88daa7c688a304d7b8dc4aceb513c9fd2447d5c343b32cf9e4edc2465a07990

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page