Skip to main content

No project description provided

Project description

Markdown Refdocs

build PyPi codecov

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

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.

Project details


Download files

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

Source Distribution

markdown_refdocs-1.2.1.tar.gz (14.6 kB view hashes)

Uploaded Source

Built Distribution

markdown_refdocs-1.2.1-py3-none-any.whl (17.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page