{ "info": { "author": "Wes Turner", "author_email": "wes@wrd.nu", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Utilities" ], "description": "\n\nsphinxcontrib-srclinks\n========================\n| Source: https://github.com/westurner/sphinxcontrib-srclinks\n| Source: https://github.com/westurner/sphinxcontrib-srclinks/blob/develop/sphinxcontrib/srclinks/__init__.py\n| Source: https://github.com/westurner/sphinxcontrib-srclinks/blob/develop/sphinxcontrib/srclinks/_templates/srclinks.html\n\nA sphinx extension to add links to various views of the documentation page source in the sphinx jinja2 template sidebar.\n\nContents\n------------\n.. contents::\n\nFeatures\n-------------\n* Specify ``srclink_project`` once in sphinx ``conf.py``\n* Adds links to {Source, Edit, History, Annotate} with {GitHub, BitBucket,} URLs to the sidebar.\n* Adds links to e.g. https://github.com/user/repo/ and https://github.com/user/repo/tree/[``srclink_branchname``]\n* Adds a `` git clone schema://git@github.com/repo `` block for each https, native git/hg, and ssh URL \n\n* (Sphinx HTML Documentation Sidebar)\n\n * This Page\n\n * Source RST\n * Source\n * Edit\n * History\n * Annotate\n\n * `github.com/westurner/sphinxcontrib-srclinks `_ / \n `master `_\n\n * git clone https://github.com/westurner/sphinxcontrib-srclinks\n * git clone git@github.com/westurner/sphinxcontrib-srclinks\n * git clone ``_\n\nUsage\n-------\n\n- Clone the sphinxcontrib-srclinks repo:\n\n.. code:: bash\n\n git clone https://github.com/westurner/sphinxcontrib-srclinks\n\n- Copy ``srclinks.html`` to the ``_templates/srclinks.html`` folder:\n\n.. code:: bash\n\n DOCS=\"./docs/\"\n mkdir -p \"$DOCS/_templates\"\n cp sphinxcontrib-srclinks/sphinxcontrib/srclinks/_templates/srclinks.html \\\n \"$DOCS/_templates/srclinks.html\"\n\n- BLD: conf.py: Configure the ``srclink_`` settings in ``conf.py`` (``test_html_page_context()``):\n\n.. code:: python\n\n # conf.py\n # srclink settings\n srclink_project = 'https://github.com/westurner/sphinxcontrib-srclinks'\n #srclink_project = 'https://bitbucket.org/westurner/sphinxcontrib-srclinks'\n #srclink_project = 'hg@bitbucket.org/westurner/sphinxcontrib-srclinks'\n #srclink_project = 'git@bitbucket.org/westurner/sphinxcontrib-srclinks'\n srclink_src_path = 'docs/'\n #srclink_src_path = ''\n srclink_branch = 'master'\n #srclink_branch = 'develop'\n\n\n- BLD: conf.py: Add ``srclinks.html`` to ``html_sidebars`` in ``conf.py``:\n\n.. code:: Python\n\n # Custom sidebar templates, maps document names to template names.\n html_sidebars = {\n '**': [\n 'localtoc.html',\n 'relations.html',\n 'searchbox.html',\n 'srclinks.html',\n ],\n 'index': [\n 'globaltoc.html',\n 'relations.html',\n 'searchbox.html',\n 'srclinks.html',\n ],\n }\n\nconf.py examples\n~~~~~~~~~~~~~~~~~~\n* https://wrdrd.github.io/ ( https://wrdrd.com/ )\n\n * conf.py: https://github.com/wrdrd/docs/blob/master/docs/conf.py\n\n\nLicense\n===========\nBSD 3-Clause\n\n\n\nChangelog\n===========\n\n0.2.4 (2019-04-16)\n-------------------\n* DOC: Add Python 2 and 3 trove classifiers\n\n0.2.3 (2019-04-16)\n-------------------\n* BUG: Python 3 Compatibility\n\n0.2.2\n------\n* ENH: _templates/srclinks.html: add class='widget navlinks|srclinks\n\n0.2.1\n------\n* DOC: CHANGELOG.rst\n\n0.2.0\n------\n* BUG: backwards compatibility with edit_on_github\n\n0.1.2\n------\n* BLD: MANIFEST.in\n\n0.1.1\n------\n* DOC: LICENSE\n\n0.1.0\n-------\n* First release as ``sphinxcontrib.srclinks``\n* ENH: Added BitBucket support (``hg@`` (default) and ``git@``)\n* TST: Added tests for BitBucket and GitHub support\n\n0.0.1\n------\n\n* https://github.com/astropy/astropy/pull/347\n\n - https://gist.github.com/mgedmin/6052926\n\n - https://gist.github.com/westurner/d89c1ea1af05c5c514f9\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-srclinks", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/westurner/sphinxcontrib-srclinks", "keywords": "", "license": "BSD (3-clause)", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-srclinks", "package_url": "https://pypi.org/project/sphinxcontrib-srclinks/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-srclinks/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-srclinks", "Homepage": "http://bitbucket.org/westurner/sphinxcontrib-srclinks" }, "release_url": "https://pypi.org/project/sphinxcontrib-srclinks/0.2.4/", "requires_dist": [ "Sphinx (>=0.6)" ], "requires_python": "", "summary": "Add source, edit, history, annotate links to GitHub or BitBucket", "version": "0.2.4" }, "last_serial": 5148782, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "20b8a35c40fb89984a7e333c3a815069", "sha256": "13343baa9cc8a06d8b247d1af95a0000120db5d76b8dffa9097840e94991dd96" }, "downloads": -1, "filename": "sphinxcontrib-srclinks-0.1.2.tar.gz", "has_sig": false, "md5_digest": "20b8a35c40fb89984a7e333c3a815069", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7647, "upload_time": "2015-01-01T00:25:26", "url": "https://files.pythonhosted.org/packages/a2/fa/b2f5ee649b865bde9b56a6da62bed990105426c4af08813b79494a673e75/sphinxcontrib-srclinks-0.1.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "c12bbe47f5e2f1bf4177866e828746f9", "sha256": "40b8d29ab06f44b58addf3daa110d9a5b7e6ceb39c84759cfd2cc6f73f19582e" }, "downloads": -1, "filename": "sphinxcontrib-srclinks-0.2.1.tar.gz", "has_sig": false, "md5_digest": "c12bbe47f5e2f1bf4177866e828746f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8218, "upload_time": "2015-01-01T01:41:00", "url": "https://files.pythonhosted.org/packages/25/fe/21209124311bf0ce5d2e4c5d61ec08247fc07da218d9f0426c09af643fd2/sphinxcontrib-srclinks-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "50c4444e6d406cac0e47f252acfd70e1", "sha256": "20a8e4846dced49fe927fb2eeea18a295c17e40f4792877d833d179235502959" }, "downloads": -1, "filename": "sphinxcontrib_srclinks-0.2.2-py2-none-any.whl", "has_sig": false, "md5_digest": "50c4444e6d406cac0e47f252acfd70e1", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 10365, "upload_time": "2017-07-19T16:53:20", "url": "https://files.pythonhosted.org/packages/19/fe/42a291ac26e1d0bf08f0aa1959cb0360b0f70a115b659152231a3ba3b12c/sphinxcontrib_srclinks-0.2.2-py2-none-any.whl" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "d45d73174f26b5275354729894b367d9", "sha256": "b84994827e0c243db729b66b1e94f6e954cc6c1fee2874b436d936680aba1095" }, "downloads": -1, "filename": "sphinxcontrib_srclinks-0.2.3-py37-none-any.whl", "has_sig": false, "md5_digest": "d45d73174f26b5275354729894b367d9", "packagetype": "bdist_wheel", "python_version": "py37", "requires_python": null, "size": 10231, "upload_time": "2019-04-16T06:20:55", "url": "https://files.pythonhosted.org/packages/e7/01/ebdb85e41275536e0f7c2868cc010e3829e42aac3e9c85acea9c44dadb97/sphinxcontrib_srclinks-0.2.3-py37-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c89c50c3680581eec28f79620a867c01", "sha256": "5edbbabf2fd2939b201cb4f01a5774faa53c38770fcd4ec1ee27340802db83db" }, "downloads": -1, "filename": "sphinxcontrib-srclinks-0.2.3.tar.gz", "has_sig": false, "md5_digest": "c89c50c3680581eec28f79620a867c01", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8802, "upload_time": "2019-04-16T06:20:57", "url": "https://files.pythonhosted.org/packages/c1/25/6e2a93abae7a96db345a28851fde607d6904f2f737a8783aa3d021dc4ed7/sphinxcontrib-srclinks-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "c2d68fa9597e8059f23483562f72aaa4", "sha256": "1bd99b551f0733fa0c41e23564d539c02404c69529a7a4a0e0dc82d7650ae178" }, "downloads": -1, "filename": "sphinxcontrib_srclinks-0.2.4-py37-none-any.whl", "has_sig": false, "md5_digest": "c2d68fa9597e8059f23483562f72aaa4", "packagetype": "bdist_wheel", "python_version": "py37", "requires_python": null, "size": 10299, "upload_time": "2019-04-16T08:28:48", "url": "https://files.pythonhosted.org/packages/fd/e8/74f46331980f5f22005c50b0e456f291cd994982bd4f4eea13727ecdd7e9/sphinxcontrib_srclinks-0.2.4-py37-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7ff5e43219b1bc11cff3f38698152bc3", "sha256": "c265d972eeda1898c5d21a62ac0f32a33a6866cae1a05b07483595dc2a4e0166" }, "downloads": -1, "filename": "sphinxcontrib-srclinks-0.2.4.tar.gz", "has_sig": false, "md5_digest": "7ff5e43219b1bc11cff3f38698152bc3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8877, "upload_time": "2019-04-16T08:28:50", "url": "https://files.pythonhosted.org/packages/fb/c2/9717dd2992b08b80fd218333d91c52a8a1678c8b9f9aaf797d03612b09de/sphinxcontrib-srclinks-0.2.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c2d68fa9597e8059f23483562f72aaa4", "sha256": "1bd99b551f0733fa0c41e23564d539c02404c69529a7a4a0e0dc82d7650ae178" }, "downloads": -1, "filename": "sphinxcontrib_srclinks-0.2.4-py37-none-any.whl", "has_sig": false, "md5_digest": "c2d68fa9597e8059f23483562f72aaa4", "packagetype": "bdist_wheel", "python_version": "py37", "requires_python": null, "size": 10299, "upload_time": "2019-04-16T08:28:48", "url": "https://files.pythonhosted.org/packages/fd/e8/74f46331980f5f22005c50b0e456f291cd994982bd4f4eea13727ecdd7e9/sphinxcontrib_srclinks-0.2.4-py37-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7ff5e43219b1bc11cff3f38698152bc3", "sha256": "c265d972eeda1898c5d21a62ac0f32a33a6866cae1a05b07483595dc2a4e0166" }, "downloads": -1, "filename": "sphinxcontrib-srclinks-0.2.4.tar.gz", "has_sig": false, "md5_digest": "7ff5e43219b1bc11cff3f38698152bc3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8877, "upload_time": "2019-04-16T08:28:50", "url": "https://files.pythonhosted.org/packages/fb/c2/9717dd2992b08b80fd218333d91c52a8a1678c8b9f9aaf797d03612b09de/sphinxcontrib-srclinks-0.2.4.tar.gz" } ] }