No project description provided
Project description
quivr-sphinx-autodoc
This is a Sphinx extension for autodoc of Quivr Tables.
Installation
Install with pip:
pip install quivr-sphinx-autodoc
Then enable by adding to the sphinx extensions in your conf.py
sphinx configuration file:
extensions = [
"sphinx.ext.autodoc",
"quivr_sphinx_autodoc",
]
Usage
Once installed, documentation for quivr.Table
subclasses will
include tables which list the columnar schema and any scalar
attributes.
This will automatically be enabled for any class declarations found
with a .. automod::
directive.
If you're manually specifying classes, use .. autoqvtable:: <tablename>
:
.. currentmodule:: adam_core.coordinates
.. autoqvtable:: CartesianCoordinates
:members:
To add documentation for table columns or attributes, use the
attribute docstring syntax, which is to lead with #:
:
class MyTable(qv.Table):
x = qv.Float64Column()
#: Example of a documented y field
y = qv.Int64Column()
#: this one is documented
#: on multiple lines
#: and has inline ReST text, which works
#:
#: .. warning::
#: Do not use
z = qv.ListColumn(pa.int32())
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.
Source Distribution
Built Distribution
Close
Hashes for quivr_sphinx_autodoc-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | beceab5fab783d9b190c84015fc4ae790b8759870e74a658bc3b793f44c1ac71 |
|
MD5 | e38a909c4247fd2c72e862871bee4d89 |
|
BLAKE2b-256 | 7cb89a99b1dba68597b3b504d3e81f1d7efeb666f4896b9f6f6b57ab194bb20c |
Close
Hashes for quivr_sphinx_autodoc-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5656e615b0dd5b91265f83c7a05899f2d4331968054572da2930d4de53dba5d6 |
|
MD5 | 5f043a4f79348c1e0af6b4f7bb38deec |
|
BLAKE2b-256 | f6566a348bf4566284d204de64231f9417377baa6c9b54267bbed984c652f505 |