code2doc

Upload Python Package

A simple documentation utility that takes the docstring from the files, functions and classes and creates markdown files.

Getting Started

Requires: python 3.6+

code2doc is available on PyPi and can be easily installed using pip.

pip install code2doc

If you already have code2doc and want to update to a newer version

pip install -U code2doc

You can get the cutting edge version directly from dev branch (this can be unstable)

pip install git+https://github.com/rahulsrma26/code2doc

Assuming you have all the source code in src/your_module directory in the current working directory then you can directory build docs using

code2doc build -m ./src/your_module

Build options can be customized using command line or code2doc.ini file. To create code2doc.ini file in the current working directory use

code2doc init

For additional help see code2doc.ini file and use help commands and sub-commands.

code2doc -h

See source code documentation here.

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for code2doc 0.0.4
File	Size	Uploaded
code2doc-0.0.4.tar.gz	12.3 kB	Apr 20, 2021	Details

Table of built distributions (wheels) for code2doc 0.0.4
File	Interpreter	ABI	Platform	Reset
code2doc-0.0.4-py3-none-any.whl 15.7 kB Apr 20, 2021	Python 3	none	any	Details

Total release size: 28.0 kB

Download URL	code2doc-0.0.4.tar.gz
Size	12.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`93523129732535830a2ff294d23013acf12dff035815af19aba8236122b2752c`
BLAKE2b-256 checksum How to use checksums	`7d7996f4d5bbb3ca64e09933eb3b827ddd2915a7fc20442562dc04d3901f3529`
Upload date	Apr 20, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.0.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4`

Download URL	code2doc-0.0.4-py3-none-any.whl
Size	15.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e3c6f541de6514e015557b7c7198321eab9f768cc2733452a11a5f626bbcc919`
BLAKE2b-256 checksum How to use checksums	`e3b42910c6c3eb1eae654701655bf256a06161fdf248cf657010fd5e9c85322a`
Upload date	Apr 20, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.1 importlib_metadata/4.0.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4`