{"repo":"NiklasRosenstein/pydoc-markdown","free":true,"listed":false,"github":"https://github.com/NiklasRosenstein/pydoc-markdown","clone":"git clone https://github.com/NiklasRosenstein/pydoc-markdown.git","description":"Create Python API documentation in Markdown format.","language":"Python","stars":500,"topics":["markdown","python","mkdocs","documentation-tool","documentation-generator","pydoc-markdown","cli","yaml-configuration","pydocmd","app"],"license":null,"category":"docs-static-sites","readme_excerpt":"Pydoc-Markdown 📃 Disclaimer : I don't find enough time to properly maintain and develop this project. If you want to generate docstrings for your Python project with MkDocs, consider mkdocstrings instead. Pydoc-Markdown is a tool to create Python API documentation in Markdown format. Instead of executing your Python code like so many other documentation tools, it parses it using docspec instead. [→ Go to the Documentation 📘][Documentation] [contrib]: https://github.com/NiklasRosenstein/pydoc-markdown/blob/develop/.github/CONTRIBUTING.md [docspec]: https://niklasrosenstein.github.io/python-docspec/ [Documentation]: https://niklasrosenstein.github.io/pydoc-markdown/ [MkDocs]: https://www.mkdocs.org/ [Novella]: https://niklasrosenstein.github.io/novella/ [Novella build backend]: https://niklasrosenstein.github.io/pydoc-markdown/usage/novella/ Table of Contents Installation 📦 Features 🌟 News 📢 4.7.0 (Undeprecating YAML configuration) 4.6.0 (Novella integration) Contributing to Pydoc-Markdown 🤝 Questions / Need help? 🤔 Projects using Pydoc-Markdown 📚 Installation 📦 You can install Pydoc-Markdown using Pipx: $ pipx install pydoc-markdown If you plan on using the [Novella][] integration, you may want to install it as: $ pipx install novella $ pipx inject novella pydoc-markdown[novella] You need at least Python 3.10 to run Pydoc-Markdown. The Python version compatibility of the package you are looking to generate documentation for is irrelevant. Features 🌟 Understands multi","default_branch":null,"files":null,"tree":[],"storefront":"/r/NiklasRosenstein","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/NiklasRosenstein/pydoc-markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}