pydoc2md
inspired by https://github.com/gbowerman/py2md
pydoc2md is lightweight python application that generates markdown (.md) files from a repository of .py. The idea is to easily generate bare bones documentation for a python project by providing a list of all classes and functions, each with their docstring.
A .md file is generated for each .py in the input didirectoryrection or in its subfolders.
This .md file includes all class/functions defined in the .py with a brief description. The result is something that looks like this:
Roadmap
This package is currently under development, bugs and breaking changes are almost garuanteed. Features that will be added soon:
- output folder structure: option to save the output
mdin a folder structure mirroring that of the input package - overall table of content: table of content with an overview of all
.mdfiles and how they're organised - > suggest new features you'd like to see added?
Usage
using pydoc2md is very simple. From the command line:
pydoc2md project/path output/path
For instance, the .md files in Docs where generated with
pydoc2md Github/pydoc2md/pydoc2md Github/pydoc2md/Docs
Installation
Currently you can isntall with:
pip install git+https://github.com/FedeClaudi/pydoc2md.git
though a pip installable version will be released when the project is more mature.
Metadata
Release files for pydoc2md 0.0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pydoc2md-0.0.0.2.tar.gz | 5.2 kB | Without provenance | Details for pydoc2md-0.0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pydoc2md-0.0.0.2-py3-none-any.whl | Python 3 | none | any | Details for pydoc2md-0.0.0.2-py3-none-any.whl |
Total release size: 17.2 kB
Release files / pydoc2md-0.0.0.2.tar.gz
| Download URL | pydoc2md-0.0.0.2.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c1de5c76ba6c6f1ffdf874ada4d382b8eb7c938ea72dca93aed60012cc83282c
|
|
BLAKE2b-256 checksum How to use checksums |
df206d2cb9e2b637a19bbaaed5fc51fa097ae060d3cb73b8aa3de63d389de38d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.4
|
Release files / pydoc2md-0.0.0.2-py3-none-any.whl
| Download URL | pydoc2md-0.0.0.2-py3-none-any.whl |
|---|---|
| Size | 12.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b9a4efcde647ca6a207835432afa24bbfedaefb36f19e35eed28b5421e3205c2
|
|
BLAKE2b-256 checksum How to use checksums |
2d880e7840d148f68fde2aabd7c78c923de7852232d7570139e34381d920caf6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.4
|
Security for pydoc2md 0.0.0.2
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.