{ "info": { "author": "Kirill Simonov (Prometheus Research, LLC)", "author_email": "xi@resolvent.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Text Processing" ], "description": "****************************************************************\n ``sphinxcontrib-newsfeed`` -- News Feed extension for Sphinx\n****************************************************************\n\nOverview\n========\n\n``sphinxcontrib-newsfeed`` is a extension for adding a simple *Blog*,\n*News* or *Announcements* section to a Sphinx_ website.\n\nFeatures:\n\n* Makes feed entries from Sphinx documents.\n* Generates a list of entries with teasers.\n* Saves the feed to a file in RSS format.\n* Supports comments via Disqus_.\n\nYou can see this extension in action at http://htsql.org/blog/. For\nmore examples, see ``demo`` directory in the source distribution.\n\nThis software is written by Kirill Simonov (`Prometheus Research, LLC`_)\nand released under BSD license.\n\n\nUsage\n=====\n\nTo enable this extension, add the following line to ``conf.py``::\n\n extensions.append('sphinxcontrib.newsfeed')\n\nTo add a comment form to news entries, you also need to specify the\nDisqus_ website identifier::\n\n disqus_shortname = '...'\n\nNow you can convert any Sphinx document to a news entry by using\ndirective ``feed-entry``. For example::\n\n Welcome!!!\n ==========\n\n .. feed-entry::\n :date: 2012-01-01\n\n Welcome to the news feed of **Elvensense**. Here we will post\n release announcements and other project news.\n\nUse ``cut`` directive to separate the entry teaser from the content::\n\n Elvensense 96 is released\n =========================\n\n .. feed-entry::\n :date: 2012-12-31\n\n We are proud to announce a new release of **Elvensense**.\n\n .. cut::\n\n Specific changes since the last release:\n\n * An exciting feature was added.\n * An annoying bug was fixed.\n\n\nTo make a list of news entries and generate an RSS file, use ``feed``\ndirective::\n\n .. feed::\n :rss: index.rss\n :title: Elvensense News\n\n release\n welcome\n\nThe body of ``feed`` directive must list documents containing news\nentries (similar to ``toctree``). The options of ``feed`` directive\ndefine the name of the RSS file and describe the feed metadata.\n\nYou need to manually update your HTML templates to add a link to the RSS\nfeed::\n\n \n\n\nReference\n=========\n\nDirectives\n----------\n\n``feed-entry``\n Specifies an entry metadata.\n\n This directive has no body.\n\n Options:\n\n ``author``\n The author of the post (optional).\n ``date``\n The date of the post in ``YYYY-MM-DD`` format.\n\n``feed``\n Inserts a list of entries with teasers at the current location.\n\n This directive should contain a list of document names (similar to\n ``toctree``). This directive adds the documents to the hierarchy,\n so that you don't need to add the to ``toctree``.\n\n Options:\n\n ``rss``\n Where to write the RSS feed (optional).\n ``title``\n The name of the RSS channel.\n ``description``\n Description of the RSS channel.\n ``link``\n The website URL.\n\n``cut``\n Separates the entry teaser from the rest of the text.\n\n This directive has no options and no body.\n\n``disqus``\n Inserts a Disqus_ comment widget.\n\n Normally you don't need to use this directive for news entries\n since, if ``disqus_shortname`` parameter is set, Disqus comment form\n is encluded automatically with every feed entry. This directive\n allows you to use Disqus with regular Sphinx documents.\n\n Options:\n\n ``shortname``\n The website identifier. Use to override ``disqus_shortname``\n configuration parameter.\n ``identifier``\n The page identifier. If not set, use the document name.\n ``title``\n The title of the page. If not set, use the document title.\n\nConfiguration parameters\n------------------------\n\n``disqus_shortname``\n Sets the unique identifier for a Disqus website. To acquire one, you\n need to register the website on http://disqus.com/.\n\n``disqus_developer``\n Sets the developer mode (``False`` or ``True``).\n\nCSS classes\n-----------\n\n``feed-meta``\n Wraps for the post metadata block.\n\n``feed-author``\n Wraps the author name.\n\n``feed-date``\n Wraps the post date.\n\n``feed-disqus``\n Wraps the Disqus comment widget.\n\n``feed-ref``\n Wraps the post title in the list of posts.\n\n``feed-more``\n Wraps the *Read more...* link.\n\n\n.. _Sphinx: http://sphinx-doc.org/\n.. _Disqus: http://disqus.org/\n.. _Prometheus Research, LLC: http://prometheusresearch.com/\n\n\n.. vim: set spell spelllang=en textwidth=72:", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-newsfeed", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/prometheus/sphinxcontrib-newsfeed", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "sphinxcontrib-newsfeed", "package_url": "https://pypi.org/project/sphinxcontrib-newsfeed/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-newsfeed/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-newsfeed", "Homepage": "http://bitbucket.org/prometheus/sphinxcontrib-newsfeed" }, "release_url": "https://pypi.org/project/sphinxcontrib-newsfeed/0.1.4/", "requires_dist": null, "requires_python": null, "summary": "News Feed extension for Sphinx", "version": "0.1.4" }, "last_serial": 1429249, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "9e7f2d7e3f62d317b8c88d4033ead35a", "sha256": "1022d97ee81b7b4af2d9154457d2d010a15faba1cf9069ffc0b225cfaf6c73e7" }, "downloads": -1, "filename": "sphinxcontrib-newsfeed-0.1.1.tar.gz", "has_sig": false, "md5_digest": "9e7f2d7e3f62d317b8c88d4033ead35a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9373, "upload_time": "2013-03-01T00:46:14", "url": "https://files.pythonhosted.org/packages/11/57/4f6600f80188a4e54793408645e95fc6ed317a8894247d9f7f8830f7e1a3/sphinxcontrib-newsfeed-0.1.1.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "93b7319f2aa53b1b39f9a94ac3b395b9", "sha256": "6556e6cb4b4d060c5795f30bc2630589c720ec3678861473155172901f295a9b" }, "downloads": -1, "filename": "sphinxcontrib_newsfeed-0.1.4-py2-none-any.whl", "has_sig": false, "md5_digest": "93b7319f2aa53b1b39f9a94ac3b395b9", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 9962, "upload_time": "2015-02-18T23:53:40", "url": "https://files.pythonhosted.org/packages/2a/dc/47314ad0fd1d0eb77f005481cffeb872eb0d13b049a6b40f1fec9da1fb33/sphinxcontrib_newsfeed-0.1.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f02110053bb04239a9b2c16d0ea76fe1", "sha256": "f78c865b1a32d249644a9c46f395b547df0dc21ed69b70898d64235b4755efb4" }, "downloads": -1, "filename": "sphinxcontrib-newsfeed-0.1.4.tar.gz", "has_sig": false, "md5_digest": "f02110053bb04239a9b2c16d0ea76fe1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10862, "upload_time": "2015-02-18T23:53:38", "url": "https://files.pythonhosted.org/packages/2b/5e/8bc839b5c4ef030bf26eede24208a49f25d00033cbd4969b3895264f14db/sphinxcontrib-newsfeed-0.1.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "93b7319f2aa53b1b39f9a94ac3b395b9", "sha256": "6556e6cb4b4d060c5795f30bc2630589c720ec3678861473155172901f295a9b" }, "downloads": -1, "filename": "sphinxcontrib_newsfeed-0.1.4-py2-none-any.whl", "has_sig": false, "md5_digest": "93b7319f2aa53b1b39f9a94ac3b395b9", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 9962, "upload_time": "2015-02-18T23:53:40", "url": "https://files.pythonhosted.org/packages/2a/dc/47314ad0fd1d0eb77f005481cffeb872eb0d13b049a6b40f1fec9da1fb33/sphinxcontrib_newsfeed-0.1.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f02110053bb04239a9b2c16d0ea76fe1", "sha256": "f78c865b1a32d249644a9c46f395b547df0dc21ed69b70898d64235b4755efb4" }, "downloads": -1, "filename": "sphinxcontrib-newsfeed-0.1.4.tar.gz", "has_sig": false, "md5_digest": "f02110053bb04239a9b2c16d0ea76fe1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10862, "upload_time": "2015-02-18T23:53:38", "url": "https://files.pythonhosted.org/packages/2b/5e/8bc839b5c4ef030bf26eede24208a49f25d00033cbd4969b3895264f14db/sphinxcontrib-newsfeed-0.1.4.tar.gz" } ] }