{ "info": { "author": "Felix Archambault", "author_email": "fel.archambault@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Build Tools", "Topic :: Software Development :: Documentation" ], "description": "\nAnsidoc\n=======\n\nA simple tool to generate ansible role's documentation.\n\nUsage\n-----\n\nThis tool generates a ``README.md`` file using data from multiple sources.\n\n\n* From role content:\n\n * role ``defaults/main.yml``\n * role ``vars/*.yml``\n\n* You content.\n\n * role ``docs/*.yml``\n * role ``docs/*.md``\n\nContent of your role ``vars/*`` and ``defaults/*`` will also be literally inserted\nin between ``yaml`` codeblocks. Put nice comments//explanations of variable's\npurpose in them!\n\nThe role ``docs`` directory may contain YAML files that will be parsed. Variables\nwithin will be use to enrich the resulting ``README.md`` file. All markdown files\nwill also be include. Top header must be of level H2. Currently there are no\nmechanism to defined the inclusion order.\n\nPrepare your role\n^^^^^^^^^^^^^^^^^\n\nFor best results, create a ``docs/.yml`` file inside your role and fill those\nvariables:\n\n.. code-block:: yaml\n\n ---\n\n github_account: \n todos: [] # (optional) list of todos to print in your README file\n\ncli\n^^^\n\n.. code-block:: shell\n\n usage: ansidoc [-h] [-v] [-V] [-d] [-s TARGET] [-nf] [-e EXCLUDE] [-p] dirpath\n\n positional arguments:\n dirpath Either a 'roles_path' wich is a roles' directory or a\n path to a single role. If 'roles_path' basename is\n 'roles' it will loop over subdirectories assuming each\n of them contains a role.\n\n optional arguments:\n -h, --help show this help message and exit\n -v, --verbose increase output verbosity\n -V, --version show program's version number and exit\n -d, --dry-run dry run, Outputs pure markdown to stdout nothing is\n written to disk\n -s TARGET (docs | README.md) Create a symlink in PWD to TARGET.\n This is useful when used from sphinx as you cannot add\n relative entries such as '../*' in the toctree. If\n unspecified, no symlink is created.\n -nf, --no-ansidoc-footer\n Do not render the ansidoc project footer.\n -e EXCLUDE, --exclude EXCLUDE\n csv list of role names to exclude. Must match\n directory name found under specified 'dirpath'\n -p, --private Consider role(s) private, e.g.: Skip installation from\n github part from rendered template.\n\n>From sphinx\n^^^^^^^^^^^\n\nYou can import in your code and pass arguments similarly as you would do on the\ncli.\n\nFor example:\n\n.. code-block:: python\n\n from ansidoc import Ansidoc\n ansidoc = Ansidoc(dirpath=, dry_run=True)\n ansidoc.run()\n\nwishlist\n--------\n\n\n* role dependency grapher\n* role variables analysis (to audit what is defined where)\n* create sphinx documentation for this program\n* make this a sphinx plugin\n* include mardown files in defined order (alphabetical?, number the files?)\n* override parts of template with custom one.\n\n * search paths to find templates (\\ ``.ansidoc/templates/*``\\ ?)\n\n* multi-role variables\n\n * search paths to find config (\\ ``.ansidoc/config.yml``\\ ?)\n * exclude list configurable in config file\n\nLicense\n-------\n\nMIT.\n\nSimilar Projects\n----------------\n\n\n* `Ansible-DocGen `_\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/archf/ansidoc", "keywords": "ansible,documentation generation", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "ansidoc", "package_url": "https://pypi.org/project/ansidoc/", "platform": "", "project_url": "https://pypi.org/project/ansidoc/", "project_urls": { "Homepage": "https://github.com/archf/ansidoc" }, "release_url": "https://pypi.org/project/ansidoc/0.6.0/", "requires_dist": [ "PyYaml", "jinja2", "tabulate" ], "requires_python": "", "summary": "Manage ansible role documentation", "version": "0.6.0" }, "last_serial": 3206870, "releases": { "0.5.6": [ { "comment_text": "", "digests": { "md5": "25f62a1e985eb741ecef4feaf7ed30ae", "sha256": "601c739e947142debac5125722b13a043d0be16a8150dca5ffed74da8fe54c83" }, "downloads": -1, "filename": "ansidoc-0.5.6-py3-none-any.whl", "has_sig": false, "md5_digest": "25f62a1e985eb741ecef4feaf7ed30ae", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9993, "upload_time": "2016-12-20T01:40:35", "url": "https://files.pythonhosted.org/packages/d7/b7/75b997183cbcab74556b37b59816847d9b40b066dfc58449121c65b1f022/ansidoc-0.5.6-py3-none-any.whl" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "fd9ffd8859a69b34e6e15958ece381cb", "sha256": "09d3e3a323e04f61ab48c5181c37ab0d1710bc9f072608e5628758c77328cb51" }, "downloads": -1, "filename": "ansidoc-0.6.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fd9ffd8859a69b34e6e15958ece381cb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13563, "upload_time": "2017-09-27T12:04:45", "url": "https://files.pythonhosted.org/packages/33/26/cd0a1bd3501bdd354a9f9cc37edcb4d00bc5d68d9874c89f9bb4bfb10c52/ansidoc-0.6.0-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fd9ffd8859a69b34e6e15958ece381cb", "sha256": "09d3e3a323e04f61ab48c5181c37ab0d1710bc9f072608e5628758c77328cb51" }, "downloads": -1, "filename": "ansidoc-0.6.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fd9ffd8859a69b34e6e15958ece381cb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13563, "upload_time": "2017-09-27T12:04:45", "url": "https://files.pythonhosted.org/packages/33/26/cd0a1bd3501bdd354a9f9cc37edcb4d00bc5d68d9874c89f9bb4bfb10c52/ansidoc-0.6.0-py3-none-any.whl" } ] }