{
    "info": {
        "author": "Adrien Lemaire",
        "author_email": "lemaire.adrien@gmail.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\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 combinaison for documenting your project would be:\n - **sphinx**\n - **django-sphinx-autodoc** 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\nCopy the generate_autodoc.py file in your project directory, then execute it.\n\nIt will scrape all your .py files in each application listed by INSTALLED_APP,\nthen add automodules in your DS_ROOT/modules.rst.\n\nYou will then see your applications grouped in 2 different categories:\n\n- **internal application** is an application located in your project directory\n- **external application** is an app which is somewhere in your pythonpath\n  (preferably in your virtualenv)\n\nGood Practices\n--------------\n\nAdd a docstring in your application's __init__.py file to describe it.\ndjango-sphinx-autodoc will automatically scrape it for you.\n\n\nSettings\n--------\n\nYou can modify some of the settings used by django-sphinx-autodoc:\n\n- **DS_ROOT**: root path for documentation (default to project_dir/doc)\n- **DS_MASTER_DOC**: name of your master document (default to \"index.rst\")\n- **DS_FILENAME**: name for the modules (default to \"auto_modules.rst\")\n- **DS_EXCLUDED_APPS**: list of applications to exclude (default to [])\n- **DS_EXCLUDED_MODULES**: list of files to exclude (default to [\"__init__.py\"])\n\n\nTODO\n----\n\n- Write tests\n- improve the not_relevant stuff to auto exclude a file without class or def\n- Django command extension to update the autodoc",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.com/Fandekasp/django-sphinx-autodoc",
        "keywords": null,
        "license": "UNKNOWN",
        "maintainer": null,
        "maintainer_email": null,
        "name": "django-sphinx-autodoc",
        "package_url": "https://pypi.org/project/django-sphinx-autodoc/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/django-sphinx-autodoc/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://github.com/Fandekasp/django-sphinx-autodoc"
        },
        "release_url": "https://pypi.org/project/django-sphinx-autodoc/0.2/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Autodoc all apps from a project to Sphinx",
        "version": "0.2"
    },
    "last_serial": 790713,
    "releases": {
        "0.0": [],
        "0.1": [],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ffb8262b860a772423c83e79d0778bca",
                    "sha256": "c465979baa0205cc21e29232b19b66ad26486c664b7364dd99bd5302baecc99a"
                },
                "downloads": -1,
                "filename": "django-sphinx-autodoc-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "ffb8262b860a772423c83e79d0778bca",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2957,
                "upload_time": "2011-06-11T03:51:52",
                "url": "https://files.pythonhosted.org/packages/aa/a1/aae6bc426487e44ea47c36f14812db611f5775b6da0b24dc8d6b6c308672/django-sphinx-autodoc-0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ffb8262b860a772423c83e79d0778bca",
                "sha256": "c465979baa0205cc21e29232b19b66ad26486c664b7364dd99bd5302baecc99a"
            },
            "downloads": -1,
            "filename": "django-sphinx-autodoc-0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "ffb8262b860a772423c83e79d0778bca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2957,
            "upload_time": "2011-06-11T03:51:52",
            "url": "https://files.pythonhosted.org/packages/aa/a1/aae6bc426487e44ea47c36f14812db611f5775b6da0b24dc8d6b6c308672/django-sphinx-autodoc-0.2.tar.gz"
        }
    ]
}