Skip to main content

Markdown Refdocs

build PyPi codecov PyPI - Downloads

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

Generate markdown reference documentation from your python package like so

markdown_refdocs /path/to/python/package -o /path/to/output/dir

This will generate markdown files under /path/to/output/dir which can be used standalone or incorporated in a Mkdocs build

Examples

Documentation for this package itself can be generated using this tool itself

markdown_refdocs markdown_refdocs -o docs/reference

This will build the following files (1 file per python sub-module)

docs/reference/
└── markdown_refdocs
    ├── links.md
    ├── main.md
    ├── markdown.md
    ├── parsers.md
    └── types.md

See a live demo of this under: https://creisle.github.io/markdown_refdocs

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

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.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for markdown-refdocs 1.4.0
File Size Uploaded Provenance Actions
markdown_refdocs-1.4.0.tar.gz 15.7 kB Without provenance Details for markdown_refdocs-1.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for markdown-refdocs 1.4.0
File Interpreter ABI Platform Actions
markdown_refdocs-1.4.0-py3-none-any.whl Python 3 none any Details for markdown_refdocs-1.4.0-py3-none-any.whl

Total release size: 34.0 kB

Release files / markdown_refdocs-1.4.0.tar.gz

Download URL markdown_refdocs-1.4.0.tar.gz
Size 15.7 kB
Tags Source
SHA-256 checksum
How to use checksums
594c573fbceadc2eb4f8366487984e76e85322bd87cee8beaf7270b6b6df6e6b
BLAKE2b-256 checksum
How to use checksums
b421849ab81772158d8a99b3dee7a07467ace25a701cbe4f4d13f6a28138f566
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

Release files / markdown_refdocs-1.4.0-py3-none-any.whl

Download URL markdown_refdocs-1.4.0-py3-none-any.whl
Size 18.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2d45796c1078dae80d861f68137e104a96c046041ae0e5b911b6fda7e440c195
BLAKE2b-256 checksum
How to use checksums
2b0b4ed80c2d5b0fb042d03f71bf01e5656ecfde624c0020617498e2e135c749
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

Security for markdown-refdocs 1.4.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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page