mkautodocs 0.3.4.3

a python package for documentation

Mkautodocs

Mkautodocs is a Python library for documentations projects

Installation

Use the package manager pip to install mkautodocs.

pip install mkautodocs

Usage

directory_name : root folder of python file's

for example:

my_project:
     src:
        routes:
               -routes.py
        - main.py
     Dockerfile
     docker-compose.yml

for this project , our directory_name must be "src"

Creating New Documentation

mkautodocs new directory_name

It creates a folder which is name's "docs" and it contains .md files of python files

Updating Documentation

mkautodocs scan directory_name

Building Documentation

mkautodocs build

It creates static codes of md files in "site" folder and a dockerfile creating inside this folder. After that writes requirement commands inside of Dockerfile.

Warning:if you use docker-compose.yml file, You must entegrate this Dockerfile in them.

Learn package's version

mkautodocs v

WARNING

in a python file, cannot be endpoints and functions together.

MIT