{
    "info": {
        "author": "Maciej Dziardziel",
        "author_email": "fiedzia@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
            "Programming Language :: Python",
            "Topic :: Software Development :: Testing"
        ],
        "description": "=============\nNoseSphinxDoc\n=============\n\n------------\nIntroduction\n------------\n\nNose plugin that will generate sphinx-formatted test documentation.\n\nWith this nose plugin you can easily automate generation of sphinx documentation\nfor your tests. NoseSphinxDoc will create set of .rst files with proper references to tests,\nreflecting structure of your modules.\n\n------------\nInstallation\n------------\n\n    ::\n\n    pip install --upgrade \"git+git://github.com/Fiedzia/NoseSphinxDoc.git#egg=Fiedzia\"\n\n-----\nUsage\n-----\n\nBasically::\n\n    nosetests --sphinx-doc --sphinx-doc-dir=/path/to/sphinx/doc/subdirectory\n\nFor example, if you have your existing sphinx documentation in ./docs directory,\nactuall call will look like this::\n\n    nosetests --sphinx-doc --sphinx-doc-dir=./docs/tests\n\nThis will create ./docs/tests directory, containing generated documentation.\nIn order to link generated documentation you will need to reference\n./doc/tests/index.rst file somewhere in your documentation.\nTop level index.rst is a good place to do that.\n\nNoseSphinxDoc does not require test to actually be run, its should happily work with\ncollect-only plugin, so you can run nose to document all tests quickly,\nand then run it again to execute only chosen subset.\n\nIf you use ``--sphinx-doc-graph`` option, a graph will be created,\nwith a simple drawing of your tests structure. This requires ``sphinx.ext.graphviz``\nto be added to sphinx extension list.\n\nIf it works for you, please let me know, i'd like to hear that i'v made something useful.\n\n---------\nDebugging\n---------\n\nIf something doesn't work:\n\n    * Make sure that nose runs succesfully without any plugins. If nose\n      will fail (you will see a failure information in nose output)\n      then so will everything else and you will have to fix this problem first.\n      If you are using several plugins, turn them on one by one,\n      to find the culprit.\n\n    * Look at ``PYTHONPATH``. You may need to set it properly for nose\n      and for sphinx, as they both will need to look at python code the same way.\n      Forcing them to do so is sometimes tricky, and nose can communicate errors\n      really poorly.\n\n    * If everything still fails, go to NoseSphinxDoc github page and create an issue,\n      providing all details and minimal code that lead to an error.",
        "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/Fiedzia/NoseSphinxDoc",
        "keywords": null,
        "license": "GNU LGPL",
        "maintainer": null,
        "maintainer_email": null,
        "name": "nose-sphinx-doc",
        "package_url": "https://pypi.org/project/nose-sphinx-doc/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/nose-sphinx-doc/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://github.com/Fiedzia/NoseSphinxDoc"
        },
        "release_url": "https://pypi.org/project/nose-sphinx-doc/0.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Generate sphinx documentation for tests.",
        "version": "0.1"
    },
    "last_serial": 795518,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f49f6dae386d38b7ea217a06fc92e224",
                    "sha256": "0ea29d2ad2751b6816f72fabcf0c28b6ab75b6fa7087b138a339cc6503abb21f"
                },
                "downloads": -1,
                "filename": "nose-sphinx-doc-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f49f6dae386d38b7ea217a06fc92e224",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11384,
                "upload_time": "2011-10-15T02:02:14",
                "url": "https://files.pythonhosted.org/packages/de/5e/c374e23e41db77c9dce6aaf5303012fa2dde9dd71c2469c168d4498b5084/nose-sphinx-doc-0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f49f6dae386d38b7ea217a06fc92e224",
                "sha256": "0ea29d2ad2751b6816f72fabcf0c28b6ab75b6fa7087b138a339cc6503abb21f"
            },
            "downloads": -1,
            "filename": "nose-sphinx-doc-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f49f6dae386d38b7ea217a06fc92e224",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 11384,
            "upload_time": "2011-10-15T02:02:14",
            "url": "https://files.pythonhosted.org/packages/de/5e/c374e23e41db77c9dce6aaf5303012fa2dde9dd71c2469c168d4498b5084/nose-sphinx-doc-0.1.tar.gz"
        }
    ]
}