Metadata-Version: 2.1
Name: pydoc-markdown
Version: 4.3.0
Summary: Create Python API documentation in Markdown format.
Home-page: https://github.com/NiklasRosenstein/pydoc-markdown
Author: Niklas Rosenstein
Author-email: rosensteinniklas@gmail.com
License: MIT
Keywords: documentation,docs,generator,markdown,pydoc
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7.0,<4.0.0
Description-Content-Type: text/markdown
Requires-Dist: click (<8.0.0,>=7.0.0)
Requires-Dist: databind.core (<2.0.0,>=1.1.2)
Requires-Dist: databind.json (<2.0.0,>=1.1.2)
Requires-Dist: docspec (<2.0.0,>=1.0.0)
Requires-Dist: docspec-python (<2.0.0,>=1.0.0)
Requires-Dist: nr.fs (<2.0.0,>=1.6.0)
Requires-Dist: nr.stream (<1.0.0,>=0.1.2)
Requires-Dist: nr.pylang.utils (<1.0.0,>=0.1.1)
Requires-Dist: requests (<3.0.0,>=2.23.0)
Requires-Dist: PyYAML (<6.0.0,>=5.3.0)
Requires-Dist: six (<2.0.0,>=1.11.0)
Requires-Dist: toml (<1.0.0,>=0.10.1)
Requires-Dist: watchdog

[MkDocs]: https://www.mkdocs.org/

![Python versions](https://img.shields.io/pypi/pyversions/pydoc-markdown?style=for-the-badge)
[![Pypi version](https://img.shields.io/pypi/v/pydoc-markdown?style=for-the-badge)](https://pypi.org/project/pydoc-markdown/)
[![Build status](https://img.shields.io/github/workflow/status/NiklasRosenstein/pydoc-markdown/Python%20package?style=for-the-badge)](https://github.com/NiklasRosenstein/pydoc-markdown/actions)
[![Docs status](https://img.shields.io/readthedocs/pydoc-markdown?style=for-the-badge)](https://pydoc-markdown.readthedocs.io/en/latest/)

# Pydoc-Markdown

Pydoc-Markdown is a tool and library to create Python API documentation in
Markdown format based on `lib2to3`, allowing it to parse your Python code
without executing it.

Pydoc-Markdown requires Python 3.7 or newer, however the code that you want to
generate API documentation for can be for any Python version.

[>> Go to the Documentation](https://pydoc-markdown.readthedocs.io/en/latest/)

## Features

* Understands multiple doc styles (Sphinx, Google, Pydoc-Markdown)
* Supports assignment docstrings (`#:` block before or string literal after the statement)
* Links references to other documented API objects [WIP]
* [MkDocs][], [Hugo](https://gohugo.io/) and [Docusaurus](https://v2.docusaurus.io/) integration

## Installation

Install Pydoc-Markdown from PyPI:

    $ pipx install 'pydoc-markdown>=4.0.0,<5.0.0'

## Quickstart (MkDocs)

    $ pipx install mkdocs
    $ pydoc-markdown --bootstrap mkdocs
    $ pydoc-markdown --bootstrap readthedocs
    $ pydoc-markdown --server --open

What this does:

1. Install [MkDocs][]
2. Create a `pydoc-markdown.yml` file in the current directory
3. Create files to render your documentation on [readthedocs.org](https://readthedocs.org/)
4. Render Markdown files from the Python modules/packages in your current
   working directory and run MkDocs to open a live-preview of the page.

## Quickstart (Hugo)

    $ pydoc-markdown --bootstrap hugo
    $ pydoc-markdown --server --open

What this does:

1. Create a `pydoc-markdown.yml` file in the current directory
2. Render Markdown files from the Python modules/packages in your current working directory
   and run Hugo to open a live-preview of the page. If Hugo is not available on your system,
   it will be downloaded automatically.

## Contributing to Pydoc-Markdown

All contributions are welcome! Check out the [Contributing](.github/CONTRIBUTING.md) guidelines.

## Questions / Need help?

Feel free to open a topic on [GitHub Discussions](https://github.com/NiklasRosenstein/pydoc-markdown/discussions)!

---

<p align="center">Copyright &copy; 2021 Niklas Rosenstein</p>


