{
    "info": {
        "author": "Florent PIGOUT",
        "author_email": "florent.pigout@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "Sphinx plugin 0.1\n=================\n\nFirst draft for sphinx like easy to use plugin. It implements basic tasks to\nmanage Sphinx documentation in Trac.\n\n1. Plugin install\n-----------------\n\nDownload the plugin sources, unzip the archive and type the easy_install command\nfrom the plugin folder::\n\n    $ easy_install setup.py install\n\nRestart the Trac project(s). As administator we can now activate the plugin.\n\nBy default the documentation source folder is './docs/source' of the project\nrepository. But in most of cases we will override this path in the *[sphinx]*\nsection of the project 'trac.ini' file::\n\n    [sphinx]\n    source_dir = /<the_doc_source_path>\n\nThis source folder is used by the project to build the sphinx documentation\nusing the *web* builder of Sphinx. If the documentation can not be generated\nfrom Trac we can specify the generated documentation path with the following\noption::\n\n    [sphinx]\n    doc_dir = /<the_doc_dir_path>\n\nWe also can set the navbar title with the following option::\n\n    [sphinx]\n    navbar_title = My documentation\n\n2. Documentation update\n-----------------------\n\nSimple params into the project url to update the documentation from the source\nfolder of the project to the Trac project folder './sphinx-docs'. Just type the\nfollowing url for update::\n\n    http://<trac_url>/<project_url>?action=refresh\n\nIn some cases the documentation can not be generated like in the identified\nfollowing case:\n\n    **automodule** *can not import part of the project*\n\n    When we use the automodule, autoclass.. directives some projects can not\n    import must requirements or config. Then Sphinx will not generate the\n    project documentation and return the following error::\n\n        list out of range\n\n    Projects like TurboGears application are concerned. We are currently\n    working on this issue and hope to purpose a solution soon.\n\n3. Documentation navigation\n---------------------------\n\nIn the right side bar of the sphinx doc in Trac we will find the three following\nfunctions:\n\n    - Table of content\n\nMenu of the content of the current displayed page.\n\n    - Relative links\n\nInclude the index and module project link, and the previous/next link(s).\n\n    - Search\n\nSimple sphinx like search function. No javascript here we perform the search on\nthe server side.\n\n4. Url API overview\n-------------------\n\nThe plugin manage the followings urls and parameters. By default the index page\nof the project documentation will be displayed.\n\n    - **/<project>/sphinx**\n        default index page\n\n    - **/<project>/sphinx?action=view&item=<page_name>**\n        *action=view* action to display a specific page of the documentation\n        *item=page_name* name of the page do display\n        *search_words=<some+words>* words of the current search (highlighted in the page)\n\n    - **/<project>/sphinx?action=index&item=genindex**\n        *action=index* display the project documentation index\n        *item=genindex* display the project documentation index\n\n    - **/<project>/sphinx?action=modules&item=modindex**\n        *action=index* display the project modules index\n        *item=genindex* display the project modules index\n\n5. Next updates\n---------------\n\nThis plugin version implements sphinx basic functionalities.\n\nPlease do not hesitate to send emails or patches if you have further needs or\nif the plugin does not manage your sphinx documentation the way we want.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://bitbucket.org/florent/sphinx-plugin",
        "keywords": "trac plugin sphinx",
        "license": "BSD",
        "maintainer": null,
        "maintainer_email": null,
        "name": "TracSphinx",
        "package_url": "https://pypi.org/project/TracSphinx/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/TracSphinx/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://bitbucket.org/florent/sphinx-plugin"
        },
        "release_url": "https://pypi.org/project/TracSphinx/0.2.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Sphinx plugin for Trac 0.11",
        "version": "0.2.1"
    },
    "last_serial": 785887,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c903e4366b788ca52249a4b287619d7c",
                    "sha256": "728f2c49bc3bfb22b2198f9f7db5115138f29b6affee251978c3160a4a4f8443"
                },
                "downloads": -1,
                "filename": "TracSphinx-0.1-py2.5.egg",
                "has_sig": false,
                "md5_digest": "c903e4366b788ca52249a4b287619d7c",
                "packagetype": "bdist_egg",
                "python_version": "2.5",
                "requires_python": null,
                "size": 57521,
                "upload_time": "2009-01-27T00:03:52",
                "url": "https://files.pythonhosted.org/packages/d7/f1/329f903b80959c6edfb94fd3d0bca2e5c294262fb6ecf202434020705c51/TracSphinx-0.1-py2.5.egg"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "73396c295760c7fcbe73f5b2d9bc4491",
                    "sha256": "30b2fa7e1958782667a2029b2a758063631eb9bb06c505ffb617e50f6291749a"
                },
                "downloads": -1,
                "filename": "TracSphinx-0.2-py2.5.egg",
                "has_sig": false,
                "md5_digest": "73396c295760c7fcbe73f5b2d9bc4491",
                "packagetype": "bdist_egg",
                "python_version": "2.5",
                "requires_python": null,
                "size": 57523,
                "upload_time": "2009-01-28T21:37:16",
                "url": "https://files.pythonhosted.org/packages/31/a3/be754cc79bba6fc63f10da23bb886bbbb5d7f991efc6812e0c4466277516/TracSphinx-0.2-py2.5.egg"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8b9f5782e201b7fe3b52b81b61bf0115",
                    "sha256": "61ae2b304af3da195f381e99b469532ff84b75ff6a8240b47a24121de3f67fd4"
                },
                "downloads": -1,
                "filename": "TracSphinx-0.2.1-py2.5.egg",
                "has_sig": false,
                "md5_digest": "8b9f5782e201b7fe3b52b81b61bf0115",
                "packagetype": "bdist_egg",
                "python_version": "2.5",
                "requires_python": null,
                "size": 57527,
                "upload_time": "2010-01-31T21:23:22",
                "url": "https://files.pythonhosted.org/packages/8e/f3/757c9be3540aef560cde5ba8c434ada372807deb2809b03c271766bb6908/TracSphinx-0.2.1-py2.5.egg"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e0c29527f5a79130a424b15185f254db",
                    "sha256": "2112e6ba4ed830f271e5b68c36207e143918ff8fa34bd872bf75545904619900"
                },
                "downloads": -1,
                "filename": "TracSphinx-0.2.1-py2.6.egg",
                "has_sig": false,
                "md5_digest": "e0c29527f5a79130a424b15185f254db",
                "packagetype": "bdist_egg",
                "python_version": "2.6",
                "requires_python": null,
                "size": 57522,
                "upload_time": "2010-01-31T22:16:39",
                "url": "https://files.pythonhosted.org/packages/fe/ae/cc54f9f189e88c46ad2b15497c87670f320f33d35d1e45656e9b1cf04969/TracSphinx-0.2.1-py2.6.egg"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8b9f5782e201b7fe3b52b81b61bf0115",
                "sha256": "61ae2b304af3da195f381e99b469532ff84b75ff6a8240b47a24121de3f67fd4"
            },
            "downloads": -1,
            "filename": "TracSphinx-0.2.1-py2.5.egg",
            "has_sig": false,
            "md5_digest": "8b9f5782e201b7fe3b52b81b61bf0115",
            "packagetype": "bdist_egg",
            "python_version": "2.5",
            "requires_python": null,
            "size": 57527,
            "upload_time": "2010-01-31T21:23:22",
            "url": "https://files.pythonhosted.org/packages/8e/f3/757c9be3540aef560cde5ba8c434ada372807deb2809b03c271766bb6908/TracSphinx-0.2.1-py2.5.egg"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e0c29527f5a79130a424b15185f254db",
                "sha256": "2112e6ba4ed830f271e5b68c36207e143918ff8fa34bd872bf75545904619900"
            },
            "downloads": -1,
            "filename": "TracSphinx-0.2.1-py2.6.egg",
            "has_sig": false,
            "md5_digest": "e0c29527f5a79130a424b15185f254db",
            "packagetype": "bdist_egg",
            "python_version": "2.6",
            "requires_python": null,
            "size": 57522,
            "upload_time": "2010-01-31T22:16:39",
            "url": "https://files.pythonhosted.org/packages/fe/ae/cc54f9f189e88c46ad2b15497c87670f320f33d35d1e45656e9b1cf04969/TracSphinx-0.2.1-py2.6.egg"
        }
    ]
}