{
    "info": {
        "author": "Anentropic",
        "author_email": "ego@anentropic.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Web Environment",
            "Framework :: Django",
            "Intended Audience :: Developers",
            "Intended Audience :: System Administrators",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "=====================\nDjango-Sphinx-autodoc\n=====================\n\n\n.. note::\n\n    Original code is from https://github.com/Aquasys/django-sphinx-autodoc\n    This version has been cleaned up and modified to work as a Django\n    management command.\n\n\nDjango is very nice in that way you can reuse a lot of applications in your\nprojects. It means for big projects that you'll get a long list of applications\nin your settings.INSTALLED_APP.\n\nIf you're using Django with Sphinx and want to autodoc all these apps in a wink\nof an eye, then this app is for you.\n\nA good combination for documenting your project would be:\n - **sphinx**\n - **cartouche** to avoid polluting your docstrings with rst syntax\n - **django-giza** to generate the doc from your applications\n - **django-sphinxdoc** to integrate the sphinx doc in your website\n\n\nHow it works\n------------\n\nIt will scrape all your .py files in each application listed by INSTALLED_APPS,\nthen add automodules in your PROJECT/SPHINX_ROOT/auto_modules.rst.\n\nYou will then see your applications grouped in 2 different categories:\n\n- **Project Apps** are applications located in your project directory\n- **3rd Party Apps** are apps which are somewhere in your pythonpath\n  (preferably in your virtualenv)\n\n\nGood Practices\n--------------\n\nAdd a docstring in your application's ``__init__.py`` file to describe it.\ndjango-giza will automatically scrape it for you (although ``__init.__.py``\nfiles are excluded by default...)\n\n\nInstall\n-------\n\n``$ pip install django-giza``\n\nThen add ``giza`` to your INSTALLED_APPS in settings.py\n\n\nUsage\n-----\n\n``$ ./manage.py giza``\n\nYou can also specify the relative path to your docs root:\n\n``$ ./manage.py giza private/documentation``\n\n\nSettings\n--------\n\nYou can modify some of the settings used by django-giza:\n\n- **GIZA_DOCS_ROOT**:\n\tRoot path for documentation (absolute path required).\n\t  \n\tdefaults to:\n\t  \t``\"PROJECT_ROOT/docs\"``\n\n- **GIZA_INDEX_DOC**:\n\tName of your master document.\n\n\tdefaults to:\n\t\t``\"index.rst\"``\n\n- **GIZA_FILENAME**:\n\tName for the generated modules doc.\n\n\tdefaults to:\n\t\t``\"auto_modules\"``\n\n- **GIZA_DOC_TITLE**:\n\tTitle for the modules page.\n\n  \tdefaults to:\n\t\t``\"Python modules\"``\n\n- **GIZA_INTERNAL_TITLE**:\n\tTitle for the internal apps section.\n\n  \tdefaults to:\n\t\t``\"Project Apps\"``\n\n- **GIZA_EXTERNAL_TITLE**:\n\tTitle for the external apps section.\n\n  \tdefaults to:\n\t\t``\"3rd Party Apps\"``\n\n- **GIZA_EXCLUDED_APPS**:\n\tList of applications to exclude. Can use wildcard at the end.\n\n  \tdefaults to:\n    \t``[\"django.*\", \"giza\"]``\n\n- **GIZA_EXCLUDED_MODULES**:\n\tList of filenames to exclude.\n \n  \tdefaults to:\n    \t``[\"__init__.py\"]``\n\n- **GIZA_AUTOMODULE_OPTIONS**:\n\tList of options to the `automodule` directive, such as\n\t\"private-members\" (without colon delimiters)\n\n  \tdefaults to:\n\t\t``[\"deprecated\", \"members\", \"private-members\", \"special-members\", \"show-inheritance\"]``\n\n\nTODO\n----\n\n- Write tests\n- improve the not_relevant stuff to auto exclude a file without class or def",
        "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/anentropic/giza",
        "keywords": null,
        "license": "LICENSE.txt",
        "maintainer": null,
        "maintainer_email": null,
        "name": "django-giza",
        "package_url": "https://pypi.org/project/django-giza/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/django-giza/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/anentropic/giza"
        },
        "release_url": "https://pypi.org/project/django-giza/0.1.6/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Autodoc all modules from a Django project's INSTALLED_APPS for Sphinx",
        "version": "0.1.6"
    },
    "last_serial": 789754,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "75fd53bce873b2c6c809d01acf4e8454",
                    "sha256": "63498ae653d9155f0c9f3fb780c37c35d88f7122e3250a1a9bf8b568d45f580e"
                },
                "downloads": -1,
                "filename": "django-giza-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "75fd53bce873b2c6c809d01acf4e8454",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5704,
                "upload_time": "2012-09-13T17:03:38",
                "url": "https://files.pythonhosted.org/packages/f1/9b/1cc19391c5bb542ee7af0565256703c7c46e2613d99eb72565b68f8e9db2/django-giza-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8ac7f2e693707798c1623406e3c7cef9",
                    "sha256": "11a556d76fbbf6766ae4eaffe29f7468ae0497b801d6c8cb46a62c1f3ed7bd88"
                },
                "downloads": -1,
                "filename": "django-giza-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "8ac7f2e693707798c1623406e3c7cef9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5715,
                "upload_time": "2012-09-13T17:08:44",
                "url": "https://files.pythonhosted.org/packages/ac/63/d785250523a60fa1c86249a21dda29ae300eebffd143c5f6c89fa7489076/django-giza-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "cbf07e289da78c021d225b128c60f4e2",
                    "sha256": "bdee450bac63a2a829e4e3bff88aef42c3dde8c17761981ba3e2000b4fa49783"
                },
                "downloads": -1,
                "filename": "django-giza-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "cbf07e289da78c021d225b128c60f4e2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6143,
                "upload_time": "2012-09-13T17:48:39",
                "url": "https://files.pythonhosted.org/packages/13/b9/a23c176791e9ab7aa493ff3affa9cefafd05f9038062ed7675de0bff0f68/django-giza-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1da36e8936f9c8ce79efe73dc6fc6186",
                    "sha256": "332623ad2142ea675654375d28435ef39106f2e28e4f31f6f7a8220d8899309a"
                },
                "downloads": -1,
                "filename": "django-giza-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "1da36e8936f9c8ce79efe73dc6fc6186",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6148,
                "upload_time": "2012-09-13T17:51:45",
                "url": "https://files.pythonhosted.org/packages/a5/ff/aba386b46a10cc6f50cddbfdca86ff8cf295e38b778c80a55a3d6f5d9bf5/django-giza-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "63b4d464d4f89ab5fb14849a37708abb",
                    "sha256": "5648968b12f94ce47cacc154700d1a202376cf94564852aea38a7ad600cc49b1"
                },
                "downloads": -1,
                "filename": "django-giza-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "63b4d464d4f89ab5fb14849a37708abb",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6171,
                "upload_time": "2012-09-13T18:04:00",
                "url": "https://files.pythonhosted.org/packages/68/f1/0c537962d3c5df224858db69d8d9536ea8ee080dd970b5131aebdca1ab0a/django-giza-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ab11638ffa45d402ab07dcc57a18acb8",
                    "sha256": "006511fd596fa0563070189dfc8f1bdeff50ec2578a73aa1e961dc5fab0cd127"
                },
                "downloads": -1,
                "filename": "django-giza-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "ab11638ffa45d402ab07dcc57a18acb8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6292,
                "upload_time": "2012-09-17T09:39:43",
                "url": "https://files.pythonhosted.org/packages/d3/62/a59f0feb88fc609786f9612a65b7821a64f4b3ee77d60253c82d416c4a59/django-giza-0.1.5.tar.gz"
            }
        ],
        "0.1.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f69cbfd5620463ee88d160ca0526f779",
                    "sha256": "a191bdd1e69ea196fbf96c25869ea0512dc348e9fbe39c3f5f61f73804c78f2f"
                },
                "downloads": -1,
                "filename": "django-giza-0.1.6.tar.gz",
                "has_sig": false,
                "md5_digest": "f69cbfd5620463ee88d160ca0526f779",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6491,
                "upload_time": "2012-09-17T11:27:41",
                "url": "https://files.pythonhosted.org/packages/98/58/de715908a7e28aceaf2ceb5fecb5f77b897b61668ed57fbeb3de72e88c7b/django-giza-0.1.6.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f69cbfd5620463ee88d160ca0526f779",
                "sha256": "a191bdd1e69ea196fbf96c25869ea0512dc348e9fbe39c3f5f61f73804c78f2f"
            },
            "downloads": -1,
            "filename": "django-giza-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "f69cbfd5620463ee88d160ca0526f779",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6491,
            "upload_time": "2012-09-17T11:27:41",
            "url": "https://files.pythonhosted.org/packages/98/58/de715908a7e28aceaf2ceb5fecb5f77b897b61668ed57fbeb3de72e88c7b/django-giza-0.1.6.tar.gz"
        }
    ]
}