NiklasRosenstein / Pydoc Markdown
Licence: other
Create Python API documentation in Markdown format.
Stars: ✭ 273
Programming Languages
python
139335 projects - #7 most used programming language
Projects that are alternatives of or similar to Pydoc Markdown
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (+339.19%)
Mutual labels: documentation-tool, documentation-generator, markdown
Daux.io
Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
Stars: ✭ 603 (+120.88%)
Mutual labels: documentation-tool, documentation-generator, markdown
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (+4.76%)
Mutual labels: documentation-tool, documentation-generator, markdown
Cgx
💻🔥CLI to generate the recommended documentation/files to improve contribution (Github, Gitlab, CodeCommit and Bitbucket)
Stars: ✭ 190 (-30.4%)
Mutual labels: cli, documentation-generator, markdown
BooGi
Generate GitBook-like modern docs/tutorial websites using Gatsby
Stars: ✭ 117 (-57.14%)
Mutual labels: documentation-tool, documentation-generator
strictdoc
Software for writing technical requirements specifications.
Stars: ✭ 80 (-70.7%)
Mutual labels: documentation-tool, documentation-generator
NextBook
NextBook is quick and easy way to build technical books or documentation with markdown that run blazingly fast.
Stars: ✭ 153 (-43.96%)
Mutual labels: documentation-tool, documentation-generator
Doxyrest
A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
Stars: ✭ 265 (-2.93%)
Mutual labels: documentation-tool, documentation-generator
cutedoc
Generate stunning documentation for any project using simple markdown files.
Stars: ✭ 16 (-94.14%)
Mutual labels: documentation-tool, documentation-generator
ank
ΛNK: Compile time docs verification and evaluation for Kotlin and Java (Temporarily moved to Arrow-kt)
Stars: ✭ 52 (-80.95%)
Mutual labels: documentation-tool, documentation-generator
Scaffdog
🐶 scaffdog is Markdown driven scaffolding tool.
Stars: ✭ 237 (-13.19%)
Mutual labels: cli, markdown
Go Termd
Package termd provides terminal markdown rendering, with code block syntax highlighting support.
Stars: ✭ 223 (-18.32%)
Mutual labels: cli, markdown
numpydoc.el
Insert NumPy style docstrings in Python functions.
Stars: ✭ 33 (-87.91%)
Mutual labels: documentation-tool, documentation-generator
Reveal Ck
Create slides with ruby (and usually in markdown)
Stars: ✭ 202 (-26.01%)
Mutual labels: cli, markdown
ocular
A documentation generator for our OSS frameworks
Stars: ✭ 42 (-84.62%)
Mutual labels: documentation-tool, documentation-generator
badge-generator
Magically generate Markdown badges for your docs 🛡️ 🦡 🧙
Stars: ✭ 104 (-61.9%)
Mutual labels: documentation-tool, documentation-generator
newdoc
The newdoc tool generates files formatted with AsciiDoc, which are used in Red Hat documentation.
Stars: ✭ 14 (-94.87%)
Mutual labels: documentation-tool, documentation-generator
tygen
Modern documentation generator for TypeScript built with ReactJS
Stars: ✭ 23 (-91.58%)
Mutual labels: documentation-tool, documentation-generator
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.6 or newer, however the code that you want to generate API documentation for can be for any Python version.
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 and Docusaurus integration
Installation
Install Pydoc-Markdown from PyPI:
$ pipx install 'pydoc-markdown>=3.0.0,<4.0.0'
Quickstart (MkDocs)
$ pipx install mkdocs
$ pydoc-markdown --bootstrap mkdocs
$ pydoc-markdown --bootstrap readthedocs
$ pydoc-markdown --server --open
What this does:
- Install MkDocs
- Create a
pydoc-markdown.yml
file in the current directory - Create files to render your documentation on readthedocs.org
- 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:
- Create a
pydoc-markdown.yml
file in the current directory - 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.
Copyright © 2020 Niklas Rosenstein
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].