{
"info": {
"author": "Mikko Ohtamaa",
"author_email": "mikko@opensourcehacker.com",
"bugtrack_url": null,
"classifiers": [
"Programming Language :: Python"
],
"description": ".. contents::\n\nIntroduction\n============\n\n`Sphinx `_ is a software development documentation tool\nwritten in `Python `_. It is used by\nhundreds of projects, of some of which you can find on\n`readthedocs.org `_.\n\n``sphinxcontrib.contributors`` Sphinx extension adds a sidebar box showing\nthe contributors of the documentation. This information is sourced from Git commits\nand Github user profiles.\n\n.. image:: https://raw.github.com/miohtama/sphinxcontrib.contributors/master/docs/screenshot.png\n :width: 200\n\nOften writing open source software documentation is a thankless task.\nProviding documentation is oversighted by many software developers.\nPeople who write documentation do not get to be in limelight like rockstar developers do.\nThe ``sphinxcontrib.contributors`` Sphinx extension\nencourages writing documentation by giving the\nface time and link love for the writers\non the documentation page itself by adding a\nnew box to Sphinx sidebar.\n\nBenefits\n\n* Give the credit where the credit is due\n\n* The process is automatic based on git history\n and there is no need to have separate contributors list\n\n* Show that the documentation is written by humans and it doesn't born automatically\n\n* Encourage people to write more documentation\n\nExamples\n=========\n\nSee `Plone Developer Documentation `_.\n\nInstallation\n==============\n\nInstall the package to your virtualenv:\n\n pip install sphinxcontrib.contributors\n\nInstall templates and static media files needed for this extension to work.\n`You can download the files from here `_.\nUse Github raw file view to download the file.\n\nAdd to your Sphinx **static** resource folder the following files::\n\n transparency.min.js\n contributors.js\n contributors.css\n\nAdd to your Sphinx **templates** folder the following files::\n\n contributors.html\n\nUsage\n=======\n\nThe Sphinx HTML is fitted with information of Github API URL where to get commit for a specific file.\nThen a JavaScript AJAX request is used to pull the commit information. The authors are parsed from the commits.\n\nYou get a Github username as tooltip, Github profile link and Github avatar of each author.\n\n* If there is Github username available, then the Github gravatar or identifcon is displayed with a\n link to Github profile page\n\n* If the commiter was not a Github author, then the committer's name is displayed on a blank\n image\n\nLimitations\n=============\n\nCurrently the authors are resolved on the client-side using Github public API.\nThis is suitable for low traffic documentation hosting.\n\n* Resolving authors during the documentation build time increases the build time considerably\n\n* With large documentation builds you might hit Github API throttling threshold,\n making it difficult to do continuous documentation builds\n\nSource code and issue tracking\n================================\n\n`See the project on Github `_.\n\nOther\n=========\n\nThe extension uses ``git`` command and Python `sh library `_ to extract the Git repository information.\n`Transparency client-side semantic templating library `_ is used to generate DOM tree for face links from Github API JSON.\n\nThis project was created in the `Plone `_ `Conference 2013 `_\nwith awesome people, many caipirinhas and a lot of fun.\n\nAuthor\n==========\n\nMikko Ohtamaa (`blog `_, `Facebook `_, `Twitter `_, `Google+ `_)\n\nChangelog\n=========\n\n1.0 (2013-10-07)\n----------------\n\n- Initial release [miohtama]",
"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/miohtama/sphinxcontrib.contributors/",
"keywords": "Sphinx",
"license": "GPL",
"maintainer": null,
"maintainer_email": null,
"name": "sphinxcontrib.contributors",
"package_url": "https://pypi.org/project/sphinxcontrib.contributors/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/sphinxcontrib.contributors/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/miohtama/sphinxcontrib.contributors/"
},
"release_url": "https://pypi.org/project/sphinxcontrib.contributors/1.0/",
"requires_dist": null,
"requires_python": null,
"summary": "Show document contributors on the page",
"version": "1.0"
},
"last_serial": 882953,
"releases": {
"1.0": [
{
"comment_text": "",
"digests": {
"md5": "c5cb2c2c3218e1b0f5670d167e0219e3",
"sha256": "2a83c75f14a3616cdbd2f518e7d528985219b3df17fa1cfc5b629058b3f2ee10"
},
"downloads": -1,
"filename": "sphinxcontrib.contributors-1.0.zip",
"has_sig": false,
"md5_digest": "c5cb2c2c3218e1b0f5670d167e0219e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 204344,
"upload_time": "2013-10-07T12:23:36",
"url": "https://files.pythonhosted.org/packages/e1/38/a1d4acd5b6a7ad04d071c1fc2b83077b4e88452c7d78c0375cdcfacc0ca2/sphinxcontrib.contributors-1.0.zip"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "c5cb2c2c3218e1b0f5670d167e0219e3",
"sha256": "2a83c75f14a3616cdbd2f518e7d528985219b3df17fa1cfc5b629058b3f2ee10"
},
"downloads": -1,
"filename": "sphinxcontrib.contributors-1.0.zip",
"has_sig": false,
"md5_digest": "c5cb2c2c3218e1b0f5670d167e0219e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 204344,
"upload_time": "2013-10-07T12:23:36",
"url": "https://files.pythonhosted.org/packages/e1/38/a1d4acd5b6a7ad04d071c1fc2b83077b4e88452c7d78c0375cdcfacc0ca2/sphinxcontrib.contributors-1.0.zip"
}
]
}