autogenerate asciidoc api documenation from docstrings
Project description
pysciidoc
pysciidoc reads python docstrings and converts them to formatted asciidoc.
It is meant to be used in conjunction with antora to
automatically generate the documentation for the python package's API.
Find full documentation at https://glencoe.github.io/pysciidoc/
Features
- automatically generate
nav.adocfile for antora - show type hints in documentation
- show default values for function arguments
Installation
pip install 'git+https://github.com/glencoe/pysciidoc.git'
Usage
pysciidoc --api-output-dir <path> --nav-file <path> <package-name>
Example using pysciidoc with antora to generate pysciidoc's API documentation
pysciidoc --api-output-dir docs/modules/api/pages \
--nav-file docs/modules/api/nav.adoc pysciidoc
Todo
- automatically format and link google doc style
- examples
- attributes
- return values
- resolve type hints for
<factory>from dataclass signatures
Not planned
- support for annotated attributes and variables
- not supported because there is no PEP specifying how to annotate these
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pysciidoc-0.2.0.tar.gz.
File metadata
- Download URL: pysciidoc-0.2.0.tar.gz
- Upload date:
- Size: 153.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ea88061750515f192a7c0592719fefd7efa0cd1b32740e2b31ef44fb7d37a076
|
|
| MD5 |
31e72ca6baa603ed711e711c27432897
|
|
| BLAKE2b-256 |
4ce046cb018e2ed4b99f3a7f79a7cbd3b339aee016371bb5635724c8cc1bd7b3
|
Provenance
The following attestation bundles were made for pysciidoc-0.2.0.tar.gz:
Publisher:
publish.yml on glencoe/pysciidoc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pysciidoc-0.2.0.tar.gz -
Subject digest:
ea88061750515f192a7c0592719fefd7efa0cd1b32740e2b31ef44fb7d37a076 - Sigstore transparency entry: 160702217
- Sigstore integration time:
-
Permalink:
glencoe/pysciidoc@5d38a8c6886cbcc17c163b4ec4bdbc2c87d8d616 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/glencoe
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@5d38a8c6886cbcc17c163b4ec4bdbc2c87d8d616 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file pysciidoc-0.2.0-py3-none-any.whl.
File metadata
- Download URL: pysciidoc-0.2.0-py3-none-any.whl
- Upload date:
- Size: 7.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
29e8783784b590dfa936a35e201f2b17537dcd77f6cb6b767165d46edd3015c1
|
|
| MD5 |
481a1bdddc3cddaad29de66cd1d9645f
|
|
| BLAKE2b-256 |
cf9c60997f55f3e01e8e706a75feb9f495bdf32a9acd80aeff7f68710fb0b971
|
Provenance
The following attestation bundles were made for pysciidoc-0.2.0-py3-none-any.whl:
Publisher:
publish.yml on glencoe/pysciidoc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pysciidoc-0.2.0-py3-none-any.whl -
Subject digest:
29e8783784b590dfa936a35e201f2b17537dcd77f6cb6b767165d46edd3015c1 - Sigstore transparency entry: 160702224
- Sigstore integration time:
-
Permalink:
glencoe/pysciidoc@5d38a8c6886cbcc17c163b4ec4bdbc2c87d8d616 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/glencoe
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@5d38a8c6886cbcc17c163b4ec4bdbc2c87d8d616 -
Trigger Event:
workflow_dispatch
-
Statement type:
