sphinx-automodapi

Sphinx extension for auto-generating API documentation for entire modules

These details have been verified by PyPI

Owner

The Astropy Project

Maintainers

bsipocz Erik.Tollerud robitaille saimon

These details have not been verified by PyPI

Project links

Homepage

Development Status
- 3 - Alpha
Intended Audience
- Developers
License
- OSI Approved :: BSD License
Operating System
- OS Independent
Programming Language

Project description

About

This is a Sphinx extension to automatically generate API pages for whole modules. It was originally developed for the Astropy project but is now available as a standalone package since it can be used for any other package. The documentation can be found on ReadTheDocs.

Note that packages from the Astropy project should continue to use this extension from the astropy-helpers rather than using this standalone package.

Project details

These details have been verified by PyPI

Owner

The Astropy Project

Maintainers

bsipocz Erik.Tollerud robitaille saimon

These details have not been verified by PyPI

Project links

Homepage

Development Status
- 3 - Alpha
Intended Audience
- Developers
License
- OSI Approved :: BSD License
Operating System
- OS Independent
Programming Language

Release history Release notifications | RSS feed

0.18.0

Sep 13, 2024

0.17.0

Feb 22, 2024

0.16.0

Aug 17, 2023

0.15.0

Mar 13, 2023

0.14.1

Jan 12, 2022

0.14.0

Dec 22, 2021

0.13

Sep 24, 2020

0.12

Aug 15, 2019

0.11

May 29, 2019

0.10

Jan 9, 2019

0.9

Nov 7, 2018

0.8

Oct 18, 2018

0.7

Jan 18, 2018

0.6

Jul 5, 2017

0.5

May 29, 2017

0.4

May 24, 2017

This version

0.3

Feb 20, 2017

0.2

Dec 28, 2016

0.1

Dec 12, 2016

Download files

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

Source Distribution

sphinx-automodapi-0.3.tar.gz (27.2 kB view details)

Uploaded Feb 20, 2017 Source

Built Distributions

sphinx_automodapi-0.3-py3-none-any.whl (49.5 kB view details)

Uploaded Feb 20, 2017 Python 3

sphinx_automodapi-0.3-py2-none-any.whl (49.5 kB view details)

Uploaded Feb 20, 2017 Python 2

File details

Details for the file sphinx-automodapi-0.3.tar.gz.

File metadata

Download URL: sphinx-automodapi-0.3.tar.gz
Upload date: Feb 20, 2017
Size: 27.2 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinx-automodapi-0.3.tar.gz
Algorithm	Hash digest
SHA256	`47cf6725f7ce68086aeae39d1ac06b72487d6d8478420222250e1120fcaee535`
MD5	`78ebd293202247c7346aaf6292b6f9fb`
BLAKE2b-256	`06522d3b4e56392c9467d751b42f3f2ef9668f729848c8eabd851adcd33fc479`

See more details on using hashes here.

Provenance

File details

Details for the file sphinx_automodapi-0.3-py3-none-any.whl.

File metadata

Download URL: sphinx_automodapi-0.3-py3-none-any.whl
Upload date: Feb 20, 2017
Size: 49.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinx_automodapi-0.3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`3825cd1e11049a386273597e6df974a5bb9bea11ec18dda4a42b814b72fc1125`
MD5	`7359cf9bdebdabc94b6330a17fdb4db3`
BLAKE2b-256	`c00bf73bd71466f52443f584b631dc11ce087aee90f6c98c2816ce7711e7c025`

See more details on using hashes here.

Provenance

File details

Details for the file sphinx_automodapi-0.3-py2-none-any.whl.

File metadata

Download URL: sphinx_automodapi-0.3-py2-none-any.whl
Upload date: Feb 20, 2017
Size: 49.5 kB
Tags: Python 2
Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinx_automodapi-0.3-py2-none-any.whl
Algorithm	Hash digest
SHA256	`16331ac4cf7a515183a1618a7d2c61cb195e1573620b3beff6049b78b239bd05`
MD5	`cc4c1a996b2816ce1c3298bd8d704da4`
BLAKE2b-256	`dc8d6ae843d2404692e7b14b080ed81563d79c923f0ab9186a38ad2c3457cf49`