Automatic generation of documentation for python projects
Project description
Welcome to AutoMacDoc
What is AutoMacDoc?
AutoMacDoc is a tool to generate documentation for Python modules or groups of functions. It is based on Python and MkDocs
Why this project?
The biggest tool to generate a documentation for a Python project is Sphinx. Unfortunately, Sphinx is (to my opinion) to difficult to setup and it supports reStructuredText. There was no good project to generate easily a documentation with MarkDown ... until now!
How to install ?
With pip pardi : pip install automacdoc
3 steps to make it works!
- Write nice docstrings for your classes and functions.
- Create an init.py file to import all the functions you want to document.
- Generate your documentation website
Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
src/
__init__.py # File that list the functions and classes to documents
... # Other python files
Recommended Docstring
def fun(arg1: int, arg2: str = 'Hello World!'):
"""
Description of your function
**Parameters**
> **arg1:** `int` -- Description of argument `arg1`.
> **arg2:** `str` -- Description of argument `arg2`.
**Returns**
> `str` -- Description of returned object.
"""
return arg2 + str(arg1)
Generate the docs
automacdoc /path/to/module path/to/folder
with /path/to/project
a path to a folder with an __init__.py
file, and /path/to/project
the path to your project where the docs
folder will be created
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.