Bioschemas lesson metadata integrated to lesson.html

.gitignore

@@ -2,3 +2,4 @@
 _build/
 venv/
 .*.sw?
+*.DS_Store

bioschemas.yml

@@ -0,0 +1,74 @@
+{
+    "@context": "https://schema.org/",
+    "@type": "LearningResource",
+    "@id": "https://coderefinery.github.io/documentation/",
+    "description": "The lesson 'How to document your research software' gives an overview of the different ways how a code project can be documented: from small projects to larger projects. Markdown and Sphinx are central tools in this lesson.",
+    "keywords": "Documentation, Sphinx",
+    "name": "How to document your research software",
+    "author": [
+        {
+            "@type": "Organization",
+            "name": "CodeRefinery"
+        },
+        {
+            "@type": "Person",
+            "name": "Radovan Bast"
+        },
+        {
+            "@type": "Person",
+            "name": "Richard Darst"
+        },
+        {
+            "@type": "Person",
+            "name": "Bj\u00f8rn Lindi"
+        },
+        {
+            "@type": "Person",
+            "name": "Stefan Negru"
+        },
+        {
+            "@type": "Person",
+            "name": "Luisa Orozco"
+        },
+        {
+            "@type": "Person",
+            "name": "Jarno Rantaharju"
+        },
+        {
+            "@type": "Person",
+            "name": "Annajiat Alim Rasel"
+        },
+        {
+            "@type": "Person",
+            "name": "Sabry Razick"
+        },
+        {
+            "@type": "Person",
+            "name": "Sven van der Burg"
+        },
+        {
+            "@type": "Person",
+            "name": "Marijn van Vliet"
+        },
+        {
+            "@type": "Person",
+            "name": "Kjartan Thor Wikfeldt"
+        },
+        {
+            "@type": "Person",
+            "name": "Samantha Wittke"
+        },
+        {
+            "@type": "Person",
+            "name": "Michele Mesiti"
+        }
+    ],
+    "educationalLevel": "Beginner",
+    "identifier": "https://doi.org/10.5281/zenodo.8280234",
+    "inLanguage": "en-UK",
+    "license": "https://creativecommons.org/licenses/by/4.0/",
+    "teaches": "Understand the importance of writing code documentation together with the source code, Know what makes a good documentation, Learn what tools can be used for writing documentation, Be able to motivate a balanced decision: sometimes READMEs are absolutely enough",
+    "url": "https://coderefinery.github.io/documentation/",
+    "isPartOf": "CodeRefinery workshop",
+    "version": "2023-08-24"
+}

content/conf.py

@@ -39,6 +39,7 @@
     # remove once sphinx_rtd_theme updated for contrast and accessibility:
     "sphinx_rtd_theme_ext_color_contrast",
     "sphinx_coderefinery_branding",
+    "sphinx_bioschemas",
 ]
 
 # Settings for myst_nb:
@@ -75,6 +76,8 @@
     "*venv*",
 ]
 
+# Add bioschemas
+bioschemas = ["bioschemas.yml"]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

content/index.md

@@ -90,7 +90,6 @@ gh-pages.md
 Shell crash course <https://youtu.be/xbTTDLA3txI>
 exercises.md
 guide.md
-license.md
 ```
 
 ```{toctree}
@@ -99,5 +98,5 @@ license.md
 
 All lessons <https://coderefinery.org/lessons/core/>
 CodeRefinery <https://coderefinery.org/>
-Reusing <https://coderefinery.org/lessons/reusing/>
+reusing.md
 ```

content/license.md → content/reusing.md

@@ -1,15 +1,35 @@
-# Credit and license
+# Reusing
 
-This material is provided by CodeRefinery under the licenses stated below.
+This lesson material is free to reuse, adapt, and cite. This page collects
+everything you need to do so.
 
+## How to cite this lesson
 
-## Website template
+If you use this lesson material, please cite it using this DOI:
+
+<https://doi.org/10.5281/zenodo.8280234>
+
+The machine-readable citation record is kept in
+[`CITATION.cff`](https://raw.githubusercontent.com/coderefinery/documentation/refs/heads/main/CITATION.cff)
+at the root of this lesson's repository, which lists the full set of
+contributing authors and stays up to date as the lesson evolves.
+
+## Structured metadata
+
+This lesson also publishes its metadata as machine-readable
+[Bioschemas](https://bioschemas.org/) / [schema.org](https://schema.org/)
+structured data, embedded as JSON-LD on every page of this site. You can
+inspect the source directly in
+[`bioschemas.yml`](https://raw.githubusercontent.com/coderefinery/documentation/refs/heads/main/bioschemas.yml).
+
+## License
+
+### Website template
 
 The website template is maintained by [CodeRefinery](https://coderefinery.org/)
 and rendered with [sphinx-lesson: structured lessons with Sphinx](https://coderefinery.github.io/sphinx-lesson/).
 
-
-## Instructional material
+### Instructional material
 
 All CodeRefinery instructional material is made available under the
 [Creative Commons Attribution license (CC-BY-4.0)](https://creativecommons.org/licenses/by/4.0/).
@@ -43,3 +63,4 @@ With the understanding that:
   permissions necessary for your intended use. For example, other
   rights such as publicity, privacy, or moral rights may limit how
   you use the material.
+

requirements.txt

@@ -3,3 +3,4 @@ sphinx-copybutton==0.5.2
 sphinx-lesson
 sphinx_rtd_theme_ext_color_contrast
 https://github.com/coderefinery/sphinx-coderefinery-branding/archive/master.zip
+sphinx-bioschemas