{ "info": { "author": "Fabrice Salvaire", "author_email": "fabrice.salvaire@orange.fr", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "=============================\n Microdata plugin for Sphinx\n=============================\n\n`Microdata`_ semantic markups support for `Sphinx`_ Documentation Generator.\n\nThis plugin is derived from `pelican-microdata`_.\n\nWritten by `Fabrice Salvaire `_.\n\nInstallation\n------------\n\nSee `sphinx-contrib`_ for more details.\n\nTo install the plugin, you have to run these commands:\n\n.. code-block:: bash\n\n python setup.py build\n python setup.py install\n\nThe PySpice source code is hosted at https://github.com/FabriceSalvaire/sphinx-microdata\n\nTo clone the Git repository, run this command in a terminal:\n\n.. code-block:: sh\n\n git clone git@github.com:FabriceSalvaire/sphinx-microdata\n\nUsage\n-----\n\nTo load the plugin, you have to add it in your ``conf.py`` file.\n\n.. code-block:: python\n\n extensions = [\n ...\n 'sphinxcontrib.microdata',\n ]\n\nDirectives\n----------\n\nMicrodata plugin provides two directives:\n\n- ``itemscope``, a block directive allowing to declare an itemscope block:\n\n .. code-block:: ReST\n\n .. itemscope:: \n :tag: element type (default: div)\n :itemprop: optionnal itemprop attribute\n :compact: optionnal\n\n Nested content\n\n- ``itemprop``, an inline directive/role allowing to annotate some text with an itemprop attribute.\n\n .. code-block:: ReST\n\n :itemprop:`Displayed text `\n :itemprop:`Displayed text `\n\nExample\n-------\n\nThis reStructuredText document:\n\n.. code-block:: ReST\n\n .. itemscope: Person\n :tag: p\n\n My name is :itemprop:`Bob Smith `\n but people call me :itemprop:`Smithy `.\n Here is my home page:\n :itemprop:`www.exemple.com `\n I live in Albuquerque, NM and work as an :itemprop:`engineer `\n at :itemprop:`ACME Corp <affiliation>`.\n\nwill result in:\n\n.. code-block:: html\n\n <p itemscope itemtype=\"http://data-vocabulary.org/Person\">\n My name is <span itemprop=\"name\">Bob Smith</span>\n but people call me <span itemprop=\"nickname\">Smithy</span>.\n Here is my home page:\n <a href=\"http://www.example.com\" itemprop=\"url\">www.example.com</a>\n I live in Albuquerque, NM and work as an <span itemprop=\"title\">engineer</span>\n at <span itemprop=\"affiliation\">ACME Corp</span>.\n </p>\n\nThis reStructuredText document using nested itemscope:\n\n.. code-block:: ReST\n\n .. itemscope:: Person\n \n My name is :itemprop:`John Doe <name>`\n \n .. itemscope:: Address\n :tag: p\n :itemprop: address\n \n I live in :itemprop:`Albuquerque <name>`\n\nwill result in:\n\n.. code-block:: html\n\n <div itemscope itemtype=\"http://data-vocabulary.org/Person\">\n <p>\n My name is <span itemprop=\"name\">John Doe</span>\n </p>\n <p itemprop=\"address\" itemscope itemtype=\"http://data-vocabulary.org/Address\">\n I live in <span itemprop=\"name\">Albuquerque</span>'\n </p>\n </div>\n\nThis reStructuredText document using nested and compact itemscope:\n\n.. code-block:: ReST\n\n .. itemscope:: Person\n :tag: p\n :compact:\n \n My name is :itemprop:`John Doe <name>`\n \n .. itemscope:: Address\n :tag: span\n :itemprop: address\n \n I live in :itemprop:`Albuquerque <name>`\n\nwill result in:\n\n.. code-block:: html\n\n <p itemscope itemtype=\"http://data-vocabulary.org/Person\">\n My name is <span itemprop=\"name\">John Doe</span>\n <span itemprop=\"address\" itemscope itemtype=\"http://data-vocabulary.org/Address\">\n I live in <span itemprop=\"name\">Albuquerque</span>\n </span>\n </p>\n\n.. .............................................................................\n\n.. _Microdata: http://schema.org\n.. _Sphinx: http://sphinx-doc.org\n.. _sphinx-contrib: https://bitbucket.org/birkenfeld/sphinx-contrib\n.. _pelican-microdata: https://github.com/noirbizarre/pelican-microdata\n\n.. End", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-microdata", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/birkenfeld/sphinx-contrib", "keywords": null, "license": "LGPL v3", "maintainer": null, "maintainer_email": null, "name": "sphinxcontrib-microdata", "package_url": "https://pypi.org/project/sphinxcontrib-microdata/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-microdata/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-microdata", "Homepage": "http://bitbucket.org/birkenfeld/sphinx-contrib" }, "release_url": "https://pypi.org/project/sphinxcontrib-microdata/0.1dev-20140921/", "requires_dist": null, "requires_python": null, "summary": "Sphinx \"microdata\" extension", "version": "0.1dev-20140921" }, "last_serial": 1232393, "releases": { "0.1dev-20131230": [], "0.1dev-20140921": [ { "comment_text": "", "digests": { "md5": "28886f815fee31ad06831caad6826e76", "sha256": "d7f9aa8b8eab00bddf8cfcc60441d66e8f777b1cb7516a31d3e160ec906c5bf1" }, "downloads": -1, "filename": "sphinxcontrib-microdata-0.1dev-20140921.tar.gz", "has_sig": false, "md5_digest": "28886f815fee31ad06831caad6826e76", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9232, "upload_time": "2014-09-21T18:10:38", "url": "https://files.pythonhosted.org/packages/28/b9/657a0cd61816e59c204009ebc48f990c39d740c835df2d105f7dcfa89699/sphinxcontrib-microdata-0.1dev-20140921.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "28886f815fee31ad06831caad6826e76", "sha256": "d7f9aa8b8eab00bddf8cfcc60441d66e8f777b1cb7516a31d3e160ec906c5bf1" }, "downloads": -1, "filename": "sphinxcontrib-microdata-0.1dev-20140921.tar.gz", "has_sig": false, "md5_digest": "28886f815fee31ad06831caad6826e76", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9232, "upload_time": "2014-09-21T18:10:38", "url": "https://files.pythonhosted.org/packages/28/b9/657a0cd61816e59c204009ebc48f990c39d740c835df2d105f7dcfa89699/sphinxcontrib-microdata-0.1dev-20140921.tar.gz" } ] }