Markdown Refdocs
Extracts docstings and type annotations from a python package to generate reference documentation in markdown. See an example of this at: https://creisle.github.io/markdown_refdocs/
Getting Started
Install the package from pip
pip install markdown_refdocs
Run this from the command line or import the function to get the markdown returns as strings and
customize. This tool has the customary help manu you can view with the -h option to see the
options documentation
markdown_refdocs -h
Features
- parses google-style docstrings
- generates markdown output (this allows the user to link into the navigation or their main docs)
- can take package directories as input
- reads type annotations
- pulls function signatures
Limitations
- currently only supports google-style docstrings. May add support for others later if requested.
Motivation
The motivation for this package was that writing docs in markdown is simpler to read and write than writing them in RST. There is an awesome package called Mkdocs for turning your markdown documents into a static site. It has a number of plugins which extract docstrings from python files, however none of them are able to use the google docstring format which I prefer. If you're using a different docstring format you can check them out here on the Mkdocs plugin wiki.
Metadata
Release files for markdown-refdocs 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| markdown_refdocs-1.2.0.tar.gz | 14.2 kB | Without provenance | Details for markdown_refdocs-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| markdown_refdocs-1.2.0-py3-none-any.whl | Python 3 | none | any | Details for markdown_refdocs-1.2.0-py3-none-any.whl |
Total release size: 30.8 kB
Release files / markdown_refdocs-1.2.0.tar.gz
| Download URL | markdown_refdocs-1.2.0.tar.gz |
|---|---|
| Size | 14.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
453d80848f1ff9d9a50720836f4f7f2892b92516709d2b4df91da4dd20a23f17
|
|
BLAKE2b-256 checksum How to use checksums |
02b4e9bd987a4c26a52ae00d44cd61ca72ea010bb14b287c0a3a8b4bc564f937
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3
|
Release files / markdown_refdocs-1.2.0-py3-none-any.whl
| Download URL | markdown_refdocs-1.2.0-py3-none-any.whl |
|---|---|
| Size | 16.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc7eeb179321ed3464bb1d8dd2fb7e8a53c0a731770f267441fe9c954a7e6110
|
|
BLAKE2b-256 checksum How to use checksums |
abcdbcda8bc95f11c8eab0d1fd686dc2c556de15d188c1ea108c0b585bc2033a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3
|
Security for markdown-refdocs 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.