{"id":16484369,"url":"https://github.com/fabricesalvaire/sphinx-microdata","last_synced_at":"2026-05-14T17:03:34.609Z","repository":{"id":12064072,"uuid":"14650803","full_name":"FabriceSalvaire/sphinx-microdata","owner":"FabriceSalvaire","description":"Microdata semantic markups support for Sphinx Documentation Generator.","archived":false,"fork":false,"pushed_at":"2014-09-21T18:11:02.000Z","size":156,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-28T23:22:41.620Z","etag":null,"topics":["sphinx-plugin"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FabriceSalvaire.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-11-23T21:31:37.000Z","updated_at":"2023-05-20T15:42:17.000Z","dependencies_parsed_at":"2022-09-03T14:30:13.649Z","dependency_job_id":null,"html_url":"https://github.com/FabriceSalvaire/sphinx-microdata","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/FabriceSalvaire/sphinx-microdata","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabriceSalvaire%2Fsphinx-microdata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabriceSalvaire%2Fsphinx-microdata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabriceSalvaire%2Fsphinx-microdata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabriceSalvaire%2Fsphinx-microdata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FabriceSalvaire","download_url":"https://codeload.github.com/FabriceSalvaire/sphinx-microdata/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabriceSalvaire%2Fsphinx-microdata/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33034788,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sphinx-plugin"],"created_at":"2024-10-11T13:16:54.965Z","updated_at":"2026-05-14T17:03:34.592Z","avatar_url":"https://github.com/FabriceSalvaire.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=============================\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 \u003chttp://fabrice-salvaire.pagesperso-orange.fr\u003e`_.\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:: \u003cSchema type\u003e\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 \u003citemprop name\u003e`\n        :itemprop:`Displayed text \u003citemprop name:http://some.url/\u003e`\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 \u003cname\u003e`\n        but people call me :itemprop:`Smithy \u003cnickanme\u003e`.\n        Here is my home page:\n        :itemprop:`www.exemple.com \u003curl:http://www.example.com\u003e`\n        I live in Albuquerque, NM and work as an :itemprop:`engineer \u003ctitle\u003e`\n        at :itemprop:`ACME Corp \u003caffiliation\u003e`.\n\nwill result in:\n\n.. code-block:: html\n\n    \u003cp itemscope itemtype=\"http://data-vocabulary.org/Person\"\u003e\n        My name is \u003cspan itemprop=\"name\"\u003eBob Smith\u003c/span\u003e\n        but people call me \u003cspan itemprop=\"nickname\"\u003eSmithy\u003c/span\u003e.\n        Here is my home page:\n        \u003ca href=\"http://www.example.com\" itemprop=\"url\"\u003ewww.example.com\u003c/a\u003e\n        I live in Albuquerque, NM and work as an \u003cspan itemprop=\"title\"\u003eengineer\u003c/span\u003e\n        at \u003cspan itemprop=\"affiliation\"\u003eACME Corp\u003c/span\u003e.\n    \u003c/p\u003e\n\nThis reStructuredText document using nested itemscope:\n\n.. code-block:: ReST\n\n    .. itemscope:: Person\n    \n        My name is :itemprop:`John Doe \u003cname\u003e`\n    \n        .. itemscope:: Address\n            :tag: p\n            :itemprop: address\n    \n            I live in :itemprop:`Albuquerque \u003cname\u003e`\n\nwill result in:\n\n.. code-block:: html\n\n    \u003cdiv itemscope itemtype=\"http://data-vocabulary.org/Person\"\u003e\n    \u003cp\u003e\n    My name is \u003cspan itemprop=\"name\"\u003eJohn Doe\u003c/span\u003e\n    \u003c/p\u003e\n    \u003cp itemprop=\"address\" itemscope itemtype=\"http://data-vocabulary.org/Address\"\u003e\n    I live in \u003cspan itemprop=\"name\"\u003eAlbuquerque\u003c/span\u003e'\n    \u003c/p\u003e\n    \u003c/div\u003e\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 \u003cname\u003e`\n    \n        .. itemscope:: Address\n            :tag: span\n            :itemprop: address\n    \n            I live in :itemprop:`Albuquerque \u003cname\u003e`\n\nwill result in:\n\n.. code-block:: html\n\n    \u003cp itemscope itemtype=\"http://data-vocabulary.org/Person\"\u003e\n    My name is \u003cspan itemprop=\"name\"\u003eJohn Doe\u003c/span\u003e\n    \u003cspan itemprop=\"address\" itemscope itemtype=\"http://data-vocabulary.org/Address\"\u003e\n    I live in \u003cspan itemprop=\"name\"\u003eAlbuquerque\u003c/span\u003e\n    \u003c/span\u003e\n    \u003c/p\u003e\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\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffabricesalvaire%2Fsphinx-microdata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffabricesalvaire%2Fsphinx-microdata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffabricesalvaire%2Fsphinx-microdata/lists"}