{
    "info": {
        "author": "Bane Sullivan",
        "author_email": "banesullivan@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: BSD License",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python"
        ],
        "description": "Generate Documentation Automatically\n====================================\n\n.. image:: https://readthedocs.org/projects/gendocs/badge/?version=latest\n   :target: https://gendocs.readthedocs.io/en/latest/?badge=latest\n   :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/gendocs.svg\n   :target: https://pypi.org/project/gendocs/\n   :alt: PyPI\n\n.. image:: https://travis-ci.org/banesullivan/gendocs.svg?branch=master\n   :target: https://travis-ci.org/banesullivan/gendocs\n   :alt: Build Status\n\n.. image:: https://img.shields.io/github/stars/banesullivan/gendocs.svg?style=social&label=Stars\n   :target: https://github.com/banesullivan/gendocs\n   :alt: GitHub\n\n\nThis is a Python package for automatically building the documentation pages to\ndocument a given Python package using Sphinx.\n``gendocs`` allows users to keep all of their documentation directly within their\npackages as pages are generated directly from the docstrings in the code!\n\nConnections\n-----------\n\nWant to see examples? Check out one of the following projects which use ``gendocs``:\n\n- `PVGeo`_: A Python package for visualizing geophysical data in VTK and ParaView\n- `ESPA Tools`_: A Python package for simple loading of Landsat imagery as NumPy arrays\n\n\n.. _ESPA Tools: https://espatools.readthedocs.io/en/latest/\n.. _PVGeo: http://docs.pvgeo.org\n\n\nGet Started\n-----------\n\nInstall ``gendocs`` from PyPI:\n\n.. code-block:: bash\n\n    $ pip install gendocs\n\n\nCookiecutter\n^^^^^^^^^^^^\n\nWant to easily create a new project that will build its own documentation?\nTry the ``gendocs`` Cookiecutter which will prompt you for your new project's\ndetails and create all the needed file structures for your new, automatically\ndocumented Python package.\n\nTo create a new project, make sure you have Cookiecutter_ installed in your\nvirtual environment:\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n\n\n.. code-block:: bash\n\n\t$ pip install cookiecutter\n\n\nNow you can use `our Cookiecutter template`_ to create a new project ready\nfor ``gendocs`` by executing the following command and following the prompts:\n\n.. _our Cookiecutter template: https://github.com/banesullivan/cookiecutter-gendocs\n\n\n.. code-block:: bash\n\n    $ cookiecutter https://github.com/banesullivan/cookiecutter-gendocs.git\n\n\nThat's it! Now you have a new Python project ready for automatic documentation\nand deployment.\n\n\nUsage\n^^^^^\n\nAlready have a Python package in need of automatic documentation? Follow these steps.\n\nThis generator is built for Sphinx (RST) documentation.\nTo document your package, setup sphinx and a ``conf.py`` then add the following\nsomewhere near the top of your ``conf.py``:\n\n.. code-block:: python\n\n    # Import the package to document:\n    import wonderfulpackage\n\n    # Automatically generate documentation pages\n    from gendocs import Generator\n    Generator().DocumentPackages(wonderfulpackage)\n\nThat's it! That code block above is all you need to do to document your package(s) thoroughly. Now you can build the Sphinx documentation, and all docs pages will be automatically generated.\n\n\n.. admonition:: Remove the `Edit on GitHub` Button\n   :class: warning\n\n    Be sure to remove the `Edit on GitHub` link from your project by following `these steps`_.\n\n    .. _these steps: https://docs.readthedocs.io/en/latest/guides/remove-edit-buttons.html\n\n\n.. admonition:: Make Your Own Homepage\n   :class: note\n\n    Note that you can also set up a base index file in your project for the ``Generator``\n    to append if you'd like to include a brief overview of the package.\n    We simply pass the filename of our README to the\n    ``DocumentPackages`` method.\n\n\nLet People Know\n---------------\n\nIf your project generates documentation automatically, please add a badge to your project to let people know! We hope that these badges will stir curiosity, involvement, and community contributions to the ``gendocs`` package.\n\nMarkdown:\n\n.. code-block:: text\n\n    [![Documentation Built by gendocs](https://img.shields.io/badge/docs%20by-gendocs-blue.svg)](https://gendocs.readthedocs.io/en/latest/)\n\n\nRST / Sphinx:\n\n.. code-block:: text\n\n    .. image:: https://img.shields.io/badge/docs%20by-gendocs-blue.svg\n       :target: https://gendocs.readthedocs.io/en/latest/\n       :alt: Documentation Built by gendocs\n\n\nContribute\n----------\nCheck out ``gendocs`` of `GitHub`_ to Contribute and make automatic documentation even better!\n\n.. _GitHub: https://github.com/banesullivan/gendocs",
        "description_content_type": "text/x-rst",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/banesullivan/gendocs",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "gendocs",
        "package_url": "https://pypi.org/project/gendocs/",
        "platform": "",
        "project_url": "https://pypi.org/project/gendocs/",
        "project_urls": {
            "Homepage": "https://github.com/banesullivan/gendocs"
        },
        "release_url": "https://pypi.org/project/gendocs/0.4.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Automatic documentation pages generation",
        "version": "0.4.0"
    },
    "last_serial": 5170729,
    "releases": {
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0ad64d84a08143a5bbf9647e21c8eddd",
                    "sha256": "4ac3d53f65a4a39d4a5a8bd59a28745b8965f5ab6be4c9f38982e2cf50a6a290"
                },
                "downloads": -1,
                "filename": "gendocs-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "0ad64d84a08143a5bbf9647e21c8eddd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7376,
                "upload_time": "2018-08-10T02:14:37",
                "url": "https://files.pythonhosted.org/packages/24/df/127aef11378b789a4a2a50ee42b0123f7cd68f1c5350ed30975838fd64af/gendocs-0.3.0.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f8717006179305fb7ebd2b001cfdefdf",
                    "sha256": "fe5bc6cb3b19ac3ec5d957be0625c168fa0d966c342c0b8990934a5965b2523f"
                },
                "downloads": -1,
                "filename": "gendocs-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f8717006179305fb7ebd2b001cfdefdf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7461,
                "upload_time": "2018-10-08T05:33:26",
                "url": "https://files.pythonhosted.org/packages/d0/6e/d6d0c2a9939a996e8d836af76adeb013caa043e41236da9bab09325f016a/gendocs-0.3.1.tar.gz"
            }
        ],
        "0.3.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6daed793b6400788741c5adc9b424687",
                    "sha256": "8c7d37708f397928070b53e32dbf8a389f7e830bd3696584402b69d3dd88f8da"
                },
                "downloads": -1,
                "filename": "gendocs-0.3.2.tar.gz",
                "has_sig": false,
                "md5_digest": "6daed793b6400788741c5adc9b424687",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7886,
                "upload_time": "2018-11-04T22:37:11",
                "url": "https://files.pythonhosted.org/packages/9d/a9/72538d46e1e66a3437ac2ef0389d577e420e0d1ac90741e188a4dec311aa/gendocs-0.3.2.tar.gz"
            }
        ],
        "0.3.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6662912fc4c4d674cbc21123a9803fdd",
                    "sha256": "f09e0554a0f81bcff94a5a84efbc1ee5d8756da2d19548b6196cca0f3ef1b6f0"
                },
                "downloads": -1,
                "filename": "gendocs-0.3.3.tar.gz",
                "has_sig": false,
                "md5_digest": "6662912fc4c4d674cbc21123a9803fdd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8042,
                "upload_time": "2019-04-21T05:02:58",
                "url": "https://files.pythonhosted.org/packages/9f/50/71127aeaf09bab6cb5922d6fa3ff4b12e665982181897f1b1c1fc56cf701/gendocs-0.3.3.tar.gz"
            }
        ],
        "0.3.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "926eecbd04c4b87473f05d6c0512f5c1",
                    "sha256": "f1df656800e09638f6223b248fab50468cae6579051be73159eadedae209e404"
                },
                "downloads": -1,
                "filename": "gendocs-0.3.4.tar.gz",
                "has_sig": false,
                "md5_digest": "926eecbd04c4b87473f05d6c0512f5c1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8039,
                "upload_time": "2019-04-21T05:26:50",
                "url": "https://files.pythonhosted.org/packages/2d/b7/171d79def39a9d67ea00d56cbf71cafbecdce55217c2010d13f94acaadfe/gendocs-0.3.4.tar.gz"
            }
        ],
        "0.3.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c61a8683ce1dd326f0164c62d74856ed",
                    "sha256": "ce39fa78ecc99eace68362630bdad98dfde3c09e711e058007081c0f7365b4a1"
                },
                "downloads": -1,
                "filename": "gendocs-0.3.5.tar.gz",
                "has_sig": false,
                "md5_digest": "c61a8683ce1dd326f0164c62d74856ed",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8041,
                "upload_time": "2019-04-21T09:41:56",
                "url": "https://files.pythonhosted.org/packages/09/fe/95e3e84c0b5d91c6db3e6ea47a0fe4135bdabb8853cd9f441b2af2913d90/gendocs-0.3.5.tar.gz"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f2a48657ef13f413afc6fd850f1e0833",
                    "sha256": "2658cf14fbce025c05443d470456135f4ec6156cbfab27149b9541f3cc687d46"
                },
                "downloads": -1,
                "filename": "gendocs-0.4.0.tar.gz",
                "has_sig": false,
                "md5_digest": "f2a48657ef13f413afc6fd850f1e0833",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8061,
                "upload_time": "2019-04-21T21:41:25",
                "url": "https://files.pythonhosted.org/packages/b2/56/1b5587b42d7ed92a21055bccf355b6470bd042fe042ccfdc8b1b7bda5fb2/gendocs-0.4.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f2a48657ef13f413afc6fd850f1e0833",
                "sha256": "2658cf14fbce025c05443d470456135f4ec6156cbfab27149b9541f3cc687d46"
            },
            "downloads": -1,
            "filename": "gendocs-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f2a48657ef13f413afc6fd850f1e0833",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8061,
            "upload_time": "2019-04-21T21:41:25",
            "url": "https://files.pythonhosted.org/packages/b2/56/1b5587b42d7ed92a21055bccf355b6470bd042fe042ccfdc8b1b7bda5fb2/gendocs-0.4.0.tar.gz"
        }
    ]
}