A Sphinx extension to embed Bioschemas profiles or any Schema.org structured metadata into your Sphinx documentation as <script type="application/ld+json"> tags.
Supports YAML and JSON formats
Embed metadata inline or load from an external file
Apply markup per-page (via directive) or globally for all pages (via conf.py)
Works with MyST for Markdown-based Sphinx projects
Installation
$ pip install sphinx-bioschemas
Then enable the extension in your conf.py:
extensions = ['sphinx_bioschemas']
Quick start
Per-page (in a .rst file):
.. bioschemas::
:format: yaml
"@context": https://schema.org/
"@type": LearningResource
name: My Tutorial
...
Or load from a file:
.. bioschemas:: bioschemas.yaml
Global (in conf.py):
bioschemas = ["bioschemas.yaml"]
Full documentation
Metadata
Release files for sphinx-bioschemas 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_bioschemas-0.2.1.tar.gz | 15.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_bioschemas-0.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 20.2 kB
Release files / sphinx_bioschemas-0.2.1.tar.gz
| Download URL | sphinx_bioschemas-0.2.1.tar.gz |
|---|---|
| Size | 15.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fc0d7feb7de8057b069a36e73efe4410ab48b87eef7767e8adb4ff3b4f8d4667
|
|
BLAKE2b-256 checksum How to use checksums |
abd359ca1ad1c4dcc4516f45c77fadacf5f71521f22dd455548cc3b13ff541b3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / sphinx_bioschemas-0.2.1-py3-none-any.whl
| Download URL | sphinx_bioschemas-0.2.1-py3-none-any.whl |
|---|---|
| Size | 5.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
373b428f5f08771caafea6d4382585be52cea04d269293f793c09d8eebc064a7
|
|
BLAKE2b-256 checksum How to use checksums |
f3614a3d6daadb91837de337a9c21b9ed4ea80ad7e4373c4c755f362ab2b5236
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|