Note

This is a forked version of the original AutoAPI, released under the same licensing, with updates specifically for the Origen project. The original source is available on its Github project.

Warning

As this is a re-release, many of the configuration values remain the same as the original. It is not advised to use this in parallel to the original package.

Introduction

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

Origen-AutoAPI (just AutoAPI going forward) is a Sphinx extension 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://origen_autoapi.readthedocs.io/

License

Copyright (C) 2015-2020 KuraLabs S.R.L

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.