معرفی شرکت ها

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

Automatic generation of documentation for python projects

ویژگی	مقدار
سیستم عامل	-
نام فایل	AutoMacDoc-0.3
نام	AutoMacDoc
نسخه کتابخانه	0.3
نگهدارنده	[]
ایمیل نگهدارنده	[]
نویسنده	Alexandre Kempf
ایمیل نویسنده	alexandre.kempf@¢ri-paris.org
آدرس صفحه اصلی	-
آدرس اینترنتی	https://pypi.org/project/AutoMacDoc/
مجوز	-

# 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](https://python.org) and [MkDocs](https://mkdocs.org) ## Why this project? The biggest tool to generate a documentation for a Python project is [Sphinx](http://sphinx-doc.org). 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! 1. Write nice docstrings for your classes and functions. 2. Create an __init__.py file to import all the functions you want to document. 3. 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 ```py3 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

نیازمندی

مقدار	نام
-	mkdocs
-	mkdocs-material
-	pymdown-extensions

نحوه نصب

نصب پکیج whl AutoMacDoc-0.3:

pip install AutoMacDoc-0.3.whl

نصب پکیج tar.gz AutoMacDoc-0.3:

pip install AutoMacDoc-0.3.tar.gz