{
    "info": {
        "author": "John Anderson",
        "author_email": "johna@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "pyramid_autodoc\n---------------\n\nSphinx extension for documenting your Pyramid APIs.\n\nInstall\n-------\n\n.. code-block:: bash\n\n    pip install pyramid_autodoc\n\nGetting Started\n---------------\n\nTo use ``pyramid_autodoc`` you just need to add it to the ``extensions``\nsection of your Sphinx ``conf.py`` file:\n\n.. code-block:: python\n\n    # conf.py\n    extensions = [..., 'pyramid_autodoc']\n\nThen just create a new ``.rst`` document that uses the ``pyramid-autodoc``\ndirective and provide the path to your Pyramid's .ini file. Here is an example:\n\n.. code-block:: rst\n\n    Welcome to my Pyramid app's API docs\n    ====================================\n\n    These are the best APIs in the world!\n\n    .. autopyramid:: /path/to/development.ini\n\nThen you can just run your ``sphinx-build`` command and it will autogenerate\nAPI documentation from your Pyramid routes and view docstrings.\n\nWe also support using sphinxcontrib-httpdomain_ format, just use the\n``:format:`` setting:\n\n.. code-block:: rst\n\n    Welcome to my Pyramid app's API docs\n    ====================================\n\n    These are the best APIs in the world!\n\n    .. autopyramid:: /path/to/development.ini\n        :format: httpdomain\n\nIgnoring Endpoints\n----------------------\nIf you have a set of endpoints that you don't want to group or skip entirely\nthere are a few options you can use:\n\n- ``:match-path:`` - Whitelist only a specific set of paths\n- ``:skip-path:`` - Blacklist a specific set of paths\n- ``:match-module:`` - Whitelist a set of modules\n- ``:skip-module:`` - Blacklist a set of modules\n\n.. code-block:: rst\n\n    Welcome to my Pyramid app's API docs\n    ====================================\n\n    These are the best APIs in the world!\n\n    .. autopyramid:: /path/to/development.ini\n        :skip-module:\n          ^myapp.v1.*\n        :match-path:\n          ^/data\n\nLinking to Source Code\n----------------------\n\nIf you want to link from the endpoint to the source code for the corresponding\nviews and you are using sphinx.ext.viewcode_, you can generate links to the\nsource code pages it generates.  Alternatively, if your source is on the web,\nyou can generate external links instead.\n\n- ``:link-code:`` - Enable links from endpoints to source code.  Assumes\n  sphinx.ext.viewcode_ is being used unless ``link-code-pattern`` is specified.\n- ``:link-code-pattern:`` - Pattern URL for generating links to source code.\n  Tokens in the pattern are replaced by the following values.\n\n  - ``{file}`` is replaced by the file path, e.g. ``pyramid_autodoc/utils.py``.\n  - ``{lineno_start}`` is replaced by the beginning line number of the view, e.g.\n    ``17``.\n  - ``{lineno_end}`` is replaced by the end line number of the view, e.g.\n    ``22``.\n\n.. code-block:: rst\n\n    Welcome to my Pyramid app's API docs\n    ====================================\n\n    Links to source code within the docs.\n\n    .. autopyramid:: /path/to/development.ini\n        :link-code:\n\n    Links to source code on GitHub.\n\n    .. autopyramid:: /path/to/development.ini\n        :link-code:\n        :link-code-pattern: https://github.com/SurveyMonkey/pyramid_autodoc/blob/master/{file}#L{lineno_start}-L{lineno_end}\n\nIn the last example, a generated link would look like\n``https://github.com/SurveyMonkey/pyramid_autodoc/blob/master/pyramid_autodoc/utils.py#L17-L22``.\n\n.. _sphinxcontrib-httpdomain: http://pythonhosted.org/sphinxcontrib-httpdomain/\n.. _sphinx.ext.viewcode: http://sphinx-doc.org/ext/viewcode.html",
        "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/SurveyMonkey/pyramid_autodoc",
        "keywords": null,
        "license": "UNKNOWN",
        "maintainer": null,
        "maintainer_email": null,
        "name": "pyramid_autodoc",
        "package_url": "https://pypi.org/project/pyramid_autodoc/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/pyramid_autodoc/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/SurveyMonkey/pyramid_autodoc"
        },
        "release_url": "https://pypi.org/project/pyramid_autodoc/1.0.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Sphinx extension for documenting your Pyramid APIs.",
        "version": "1.0.0"
    },
    "last_serial": 2089267,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d91748b2c294899c961dc5175e5b40fd",
                    "sha256": "177dc584c950c3b13a853b9dd3b42e525be9d06ed463a4a09ecf6b270bf8b8e8"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "d91748b2c294899c961dc5175e5b40fd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6275,
                "upload_time": "2015-02-05T17:59:23",
                "url": "https://files.pythonhosted.org/packages/17/cc/e92646362fc98389ff15bb4e16d8f8b73a88d59f88a12040f45af366faab/pyramid_autodoc-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "feb6297bba86b784ec0da3bc69427df2",
                    "sha256": "2e79432c68157fb539d5bcba6a2a45abd854e208615780a64f6dcecd352a7a4e"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "feb6297bba86b784ec0da3bc69427df2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6523,
                "upload_time": "2015-02-05T21:46:11",
                "url": "https://files.pythonhosted.org/packages/5d/35/a442daa9b8ebf9b1b6f0dcfba3c5400a3a42b9cc2f7ab8d30e7bb0d4d7dd/pyramid_autodoc-0.0.2.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3ab876404a18ad5f53ac458cc67b4970",
                    "sha256": "4b5e942230fe57ee39a3c70bade22a1f916b2180fb0c557c0bccdaa7b76c3875"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "3ab876404a18ad5f53ac458cc67b4970",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6619,
                "upload_time": "2015-02-05T23:30:09",
                "url": "https://files.pythonhosted.org/packages/9f/34/81d219e3618cc019358a4d4efa240350cd92269c6b5027a874eff7ff16f8/pyramid_autodoc-0.0.3.tar.gz"
            }
        ],
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f1a1e689efeed993abd99b3aa0cb0d11",
                    "sha256": "9ac04279b9344147976f17fb5cccfcddbff392c68eb5b6e57df4825676504a06"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "f1a1e689efeed993abd99b3aa0cb0d11",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7825,
                "upload_time": "2015-02-14T00:58:55",
                "url": "https://files.pythonhosted.org/packages/0d/8f/9e878840731c9630596977611aa7ec5899557d062da9a66a414748ad548b/pyramid_autodoc-0.0.4.tar.gz"
            }
        ],
        "0.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6784b1fe0726f442abfa9bff5ad2545f",
                    "sha256": "807d1e5eee2a39c433132f0ba919e9ee851deaebbecb943b2ae9490aeb9d6726"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "6784b1fe0726f442abfa9bff5ad2545f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7469,
                "upload_time": "2015-02-14T01:03:27",
                "url": "https://files.pythonhosted.org/packages/77/f5/8d3ba21ad7a7991cdc403ad14c7013c59f0b1279fbe84c3d01a0a42ab276/pyramid_autodoc-0.0.5.tar.gz"
            }
        ],
        "0.0.5.post5": [],
        "0.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "90a51711209a441c380ed152a2f49e7a",
                    "sha256": "4446e681c6218cd75456c835550b658e95a348bc765ff4dd5a191fa96a7913f8"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "90a51711209a441c380ed152a2f49e7a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8868,
                "upload_time": "2015-05-06T21:20:18",
                "url": "https://files.pythonhosted.org/packages/83/ae/69138293a480d34e7761fa751521998794e44a67831603d408de623140b3/pyramid_autodoc-0.0.6.tar.gz"
            }
        ],
        "0.0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1d576db230367fea2d021e1f44916f88",
                    "sha256": "72b209fe2554e6accbbd3e1a72389d4f752bf12e04138b284abb9268561a9087"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.7-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "1d576db230367fea2d021e1f44916f88",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 9742,
                "upload_time": "2015-05-28T18:25:05",
                "url": "https://files.pythonhosted.org/packages/35/65/4401930216f36b2a98eee91ee728660c8c12e82be45995f87eb770f1d32b/pyramid_autodoc-0.0.7-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2733c8d529d1ae413ab828875f8da097",
                    "sha256": "edc478cd2771d4ff1ff9e4d893e0290339636d483717fadb97f3477171018740"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.7.tar.gz",
                "has_sig": false,
                "md5_digest": "2733c8d529d1ae413ab828875f8da097",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8929,
                "upload_time": "2015-05-28T18:25:09",
                "url": "https://files.pythonhosted.org/packages/82/96/e405845f2c4dc4e37b7bef225bab7623df6994d438045643c3bfcd2a0dee/pyramid_autodoc-0.0.7.tar.gz"
            }
        ],
        "0.0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1e26955a981093ce232a31def2def5d3",
                    "sha256": "b4d47b7b2e91dc548b4c6bc3a032d74fdeff173a086e644f5064171cc556d940"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-0.0.8.tar.gz",
                "has_sig": false,
                "md5_digest": "1e26955a981093ce232a31def2def5d3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9005,
                "upload_time": "2016-02-10T17:04:49",
                "url": "https://files.pythonhosted.org/packages/ad/4b/f1861c2e4966136bd6ca8ffbd5040b59853b9797b76cbc72503a6ed9d32f/pyramid_autodoc-0.0.8.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "69faec7bf6943507ece34844cb5e253c",
                    "sha256": "0129be62423eb246bd209841e67a091477160adf28824963315f1e94e8f00cbc"
                },
                "downloads": -1,
                "filename": "pyramid_autodoc-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "69faec7bf6943507ece34844cb5e253c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9091,
                "upload_time": "2016-04-28T17:57:45",
                "url": "https://files.pythonhosted.org/packages/de/2c/4b5a74cbae2704aae8fd52861025582674d4a8b78162a06bd05d8c3a1990/pyramid_autodoc-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "69faec7bf6943507ece34844cb5e253c",
                "sha256": "0129be62423eb246bd209841e67a091477160adf28824963315f1e94e8f00cbc"
            },
            "downloads": -1,
            "filename": "pyramid_autodoc-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "69faec7bf6943507ece34844cb5e253c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9091,
            "upload_time": "2016-04-28T17:57:45",
            "url": "https://files.pythonhosted.org/packages/de/2c/4b5a74cbae2704aae8fd52861025582674d4a8b78162a06bd05d8c3a1990/pyramid_autodoc-1.0.0.tar.gz"
        }
    ]
}