pyramid_autodoc

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!

.. pyramid-autodoc::
   :ini: /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.

Project details

Release history Release notifications | RSS feed

1.0.0

Apr 28, 2016

0.0.8

Feb 10, 2016

0.0.7

May 28, 2015

0.0.6

May 6, 2015

0.0.5.post5

May 6, 2015

0.0.5

Feb 14, 2015

0.0.4

Feb 14, 2015

0.0.3

Feb 5, 2015

0.0.2

Feb 5, 2015

This version

0.0.1

Feb 5, 2015

Download files

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

Source Distribution

pyramid_autodoc-0.0.1.tar.gz (6.3 kB view details)

Uploaded Feb 5, 2015 Source

File details

Details for the file pyramid_autodoc-0.0.1.tar.gz.

File metadata

Download URL: pyramid_autodoc-0.0.1.tar.gz
Upload date: Feb 5, 2015
Size: 6.3 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for pyramid_autodoc-0.0.1.tar.gz
Algorithm	Hash digest
SHA256	`177dc584c950c3b13a853b9dd3b42e525be9d06ed463a4a09ecf6b270bf8b8e8`
MD5	`d91748b2c294899c961dc5175e5b40fd`
BLAKE2b-256	`17cce92646362fc98389ff15bb4e16d8f8b73a88d59f88a12040f45af366faab`