sphinx-bioschemas 0.3.0

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"]

Validation (optional)

Markup can be checked against schema.org/JSON-LD basics and, for records that declare a Bioschemas profile via conformsTo, against that profile’s own machine-readable $validation JSON Schema (missing Minimum properties, missing Recommended properties, and type/shape errors).

$ pip install "sphinx-bioschemas[validate]"

# conf.py
bioschemas_validate = "warn"                 # False (default) | "info" | "warn" | "strict"
bioschemas_validate_profile_dir = "_profiles" # local dir of downloaded profile spec JSON files

Findings are reported through Sphinx’s own warning system (sphinx-build -W gates them; suppress_warnings = ["bioschemas.recommended"] etc. filters them).

The .. bioschemas:: directive also accepts :validate: (info/warn/strict/off, overriding the site-wide setting for that record) and :no-validate: (always skip).

Full documentation

https://biocorecrg.github.io/sphinx-bioschemas/