{
    "info": {
        "author": "Alexandre Kempf",
        "author_email": "alexandre.kempf@\u00a2ri-paris.org",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# Welcome to AutoMacDoc\n\n## What is AutoMacDoc?\nAutoMacDoc is a tool to generate documentation for Python modules or groups\nof functions. It is based on [Python](https://python.org) and [MkDocs](https://mkdocs.org)\n\n## Why this project?\nThe biggest tool to generate a documentation for a Python project is [Sphinx](http://sphinx-doc.org).\nUnfortunately, Sphinx is (to my opinion) to difficult to setup and it supports reStructuredText.\nThere was no good project to generate easily a documentation with MarkDown ... until now!\n\n## How to install ?\nWith pip pardi : `pip install automacdoc`\n\n## 3 steps to make it works!\n 1. Write nice docstrings for your classes and functions.\n 2. Create an __init__.py file to import all the functions you want to document.\n 3. Generate your documentation website\n\n## Project layout\n    mkdocs.yml      # The configuration file.\n    docs/\n        index.md    # The documentation homepage.\n        ...         # Other markdown pages, images and other files.\n    src/\n        __init__.py # File that list the functions and classes to documents\n        ...         # Other python files\n\n## Recommended Docstring\n```py3\ndef fun(arg1: int, arg2: str = 'Hello World!'):\n    \"\"\"\n    Description of your function\n\n    **Parameters**\n\n    > **arg1:** `int` -- Description of argument `arg1`.\n\n    > **arg2:** `str` -- Description of argument `arg2`.\n\n    **Returns**\n\n    > `str` -- Description of returned object.\n    \"\"\"\n    return arg2 + str(arg1)\n```\n\n\n## Generate the docs\n`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\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "AutoMacDoc",
        "package_url": "https://pypi.org/project/AutoMacDoc/",
        "platform": "",
        "project_url": "https://pypi.org/project/AutoMacDoc/",
        "project_urls": null,
        "release_url": "https://pypi.org/project/AutoMacDoc/0.3/",
        "requires_dist": [
            "mkdocs",
            "mkdocs-material",
            "pymdown-extensions"
        ],
        "requires_python": "",
        "summary": "Automatic generation of documentation for python projects",
        "version": "0.3"
    },
    "last_serial": 5395919,
    "releases": {
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "77a8c43297990f77703ca28d850c8bbc",
                    "sha256": "a49876a9a0c58c66d6debf10e7602a81976983152876622b5f7bc35fbe30ea5a"
                },
                "downloads": -1,
                "filename": "AutoMacDoc-0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "77a8c43297990f77703ca28d850c8bbc",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5193,
                "upload_time": "2019-05-26T21:55:07",
                "url": "https://files.pythonhosted.org/packages/77/da/d49b989335942510371e4ba9f1ea3bc8d705483838b0e54cc43887dc32ee/AutoMacDoc-0.2-py3-none-any.whl"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6f738a5690f7a1d33ce50827ed6e56c8",
                    "sha256": "41a9dfd5ffe8100b26589cc4ced29778311b98d9091a171acaa9398831547aac"
                },
                "downloads": -1,
                "filename": "AutoMacDoc-0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6f738a5690f7a1d33ce50827ed6e56c8",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9086,
                "upload_time": "2019-06-13T13:29:22",
                "url": "https://files.pythonhosted.org/packages/96/d6/dff32a323a003a148408f2c8b454e1263215a50fa2018f125ba771a8a069/AutoMacDoc-0.3-py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6f738a5690f7a1d33ce50827ed6e56c8",
                "sha256": "41a9dfd5ffe8100b26589cc4ced29778311b98d9091a171acaa9398831547aac"
            },
            "downloads": -1,
            "filename": "AutoMacDoc-0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6f738a5690f7a1d33ce50827ed6e56c8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9086,
            "upload_time": "2019-06-13T13:29:22",
            "url": "https://files.pythonhosted.org/packages/96/d6/dff32a323a003a148408f2c8b454e1263215a50fa2018f125ba771a8a069/AutoMacDoc-0.3-py3-none-any.whl"
        }
    ]
}