Sphinx extension for documenting your Pyramid APIs.
Project description
pyramid_autodoc
Sphinx extension for documenting your Pyramid APIs.
Install
pip install pyramid_autodoc
Getting Started
To use pyramid_autodoc you just need to add it to the extensions section of your Sphinx conf.py file:
# conf.py
extensions = [..., 'pyramid_autodoc']
Then just create a new .rst document that uses the pyramid-autodoc directive and provide the path to your Pyramid’s .ini file. Here is an example:
Welcome to my Pyramid app's API docs
====================================
These are the best APIs in the world!
.. autopyramid:: /path/to/development.ini
Then you can just run your sphinx-build command and it will autogenerate API documentation from your Pyramid routes and view docstrings.
We also support using sphinxcontrib-httpdomain format, just use the :format: setting:
Welcome to my Pyramid app's API docs
====================================
These are the best APIs in the world!
.. autopyramid:: /path/to/development.ini
:format: httpdomain
Ignoring Endpoints
If you have a set of endpoints that you don’t want to group or skip entirely there are a few options you can use:
:match-path: - Whitelist only a specific set of paths
:skip-path: - Blacklist a specific set of paths
:match-module: - Whitelist a set of modules
:skip-module: - Blacklist a set of modules
Welcome to my Pyramid app's API docs
====================================
These are the best APIs in the world!
.. autopyramid:: /path/to/development.ini
:skip-module:
^myapp.v1.*
:match-path:
^/data
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.