{
    "info": {
        "author": "Lars Kellogg-Stedman",
        "author_email": "lars@oddbit.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "This is a tool for generating HTML documentation from anything that\nuses `#` as a comment character.  I originally put it together for\nproducing documentation from [Ansible][] playbooks, but it works\nequally well with Python, shell scripts, etc.\n\n[ansible]: http://ansible.com/\n\n## Synopsis\n\n    usage: shdoc [-h] [--template TEMPLATE] [--chunk-template CHUNK_TEMPLATE]\n                 [--title TITLE] [--shortname] [--output OUTPUT]\n                 [--language LANGUAGE] [--map-extension MAP_EXTENSION]\n                 [--metadata METADATA]\n                 [input]\n\n\n## Options\n\n- `--template-directory`, `-t` `DIRECTORY`\n\n  Specifies the path to a directory containing [Jinja2][] templates.  The\n  main template is called `template.html`.  You may override any or\n  all of the internal templates.\n\n- `--title`, `-T` `TITLE`\n\n  Set the document title.  This will be available to the template as\n  the `title` variable.\n\n- `--shortname`\n\n  By default, if you don't provide an explicit title with `--title`,\n  the document title will be the full path of the input document.  If\n  you specify `--shortname`, the title will be the basename of the\n  input document.\n\n- `--output`, `-o` `OUTPUT`\n\n  Send output to the named file, rather than `stdout`.\n\n- `--language`, `-l` `LANGUAGE`\n\n  Set the default value of the `language` variable to `LANGUAGE`.\n  This value will be used if a language cannot be determined from an\n  extension mapping (see `--map-extension`).  This value will be\n  available to your template in the `language` variable.\n\n- `--map-extension`, `-m` `EXT=LANGUAGE`\n\n  Map file extensions to values of the `language` keyword.  For\n  example, `-m .py=python` would set `language` to `python` if you are\n  processing a `.py` file.\n\n  This option may be specified multiple times:\n\n      shdoc -m .py=python -m .yml=yaml ...\n\n- `--metadata`, `-d` `KEY=VALUE`\n\n  Sets arbitrary metadata that will be available to your templates in\n  the `metadata` dictionary.\n\n[jinja2]: http://jinja.pocoo.org/docs/dev/templates/\n\n## Example\n\nRun:\n\n    shdoc shdoc/main.py --title 'An Example' -o main.html\n\nAnd then open the resulting `main.html` file in your browser.  This\nwill render `shdoc/main.py` using the default template, which isn't\nvery pretty but shows how things work.\n\nFor real world use, you would probably want a fancier template,\npossibly including things like Javascript-driven syntax highlighting.\n\n## License\n\nshdoc, a documentation generator  \nCopyright (C) 2016 Lars Kellogg-Stedman <lars@oddbit.com>\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see <http://www.gnu.org/licenses/>.\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/larsks/shdoc",
        "keywords": null,
        "license": "UNKNOWN",
        "maintainer": null,
        "maintainer_email": null,
        "name": "shdoc",
        "package_url": "https://pypi.org/project/shdoc/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/shdoc/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/larsks/shdoc"
        },
        "release_url": "https://pypi.org/project/shdoc/0.2/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "UNKNOWN",
        "version": "0.2"
    },
    "last_serial": 2095037,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "673e85126c76043bb5d4f36a1bca89ca",
                    "sha256": "8eea16e68e09b49b387a4d37dbf04ff7cca6b275cd51a99f8d1588e090a26f8e"
                },
                "downloads": -1,
                "filename": "shdoc-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "673e85126c76043bb5d4f36a1bca89ca",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17915,
                "upload_time": "2016-05-02T14:32:11",
                "url": "https://files.pythonhosted.org/packages/e8/b0/156335675ce04304b8e8ecb1ded99ee9252bc695a9ba09b73b97b528cb53/shdoc-0.1.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "28a6b9f54b3198c42085fe2f9b042228",
                    "sha256": "a242189249c382061c685153e7f4b52bc1f0ce1f7335ec21f31d5bb8351d28f4"
                },
                "downloads": -1,
                "filename": "shdoc-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "28a6b9f54b3198c42085fe2f9b042228",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 28240,
                "upload_time": "2016-05-02T14:36:04",
                "url": "https://files.pythonhosted.org/packages/d0/13/6f759133af745f5a12cd58237938d51b382c6034379dfc2270199dbe8ae8/shdoc-0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "28a6b9f54b3198c42085fe2f9b042228",
                "sha256": "a242189249c382061c685153e7f4b52bc1f0ce1f7335ec21f31d5bb8351d28f4"
            },
            "downloads": -1,
            "filename": "shdoc-0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "28a6b9f54b3198c42085fe2f9b042228",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 28240,
            "upload_time": "2016-05-02T14:36:04",
            "url": "https://files.pythonhosted.org/packages/d0/13/6f759133af745f5a12cd58237938d51b382c6034379dfc2270199dbe8ae8/shdoc-0.2.tar.gz"
        }
    ]
}