Merge pull request #1163 from UAlbertaALTLab/1162-fix-documentation-b…

…uild-process

Finally documentation build remotely.

.readthedocs.yaml

@@ -5,13 +5,17 @@
 # Required
 version: 2
 
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
    configuration: docs/conf.py
    fail_on_warning: true
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-   version: 3.8
    install:
    - requirements: docs/requirements.txt

docs/conf.py

@@ -17,7 +17,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "morphodict"
-copyright = "2021, University of Alberta ALTLab"
+copyright = "2024, University of Alberta ALTLab"
 author = "University of Alberta ALTLab"
 
 # -- General configuration ---------------------------------------------------
@@ -27,6 +27,8 @@
 # ones.
 extensions = ["myst_parser"]
 
+myst_enable_extensions = ["attrs_inline"]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -35,6 +37,8 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+# myst-parser now requires explict declaration of anchors.
+myst_heading_anchors = 6
 
 # -- Options for HTML output -------------------------------------------------
 

docs/glossary.md

@@ -239,9 +239,9 @@ other hand, tells you enough to be able to [inflect].
 
 #### In Plains Cree
 
-* Noun — contains the word classes: [NI], [NA], [NID], [NAD]
-* Verb — contains the word classes: [VII], [VAI], [VTI], [VTA]
-* Indeclinable particle
+- Noun — contains the word classes: [NI], [NA], [NID], [NAD]
+- Verb — contains the word classes: [VII], [VAI], [VTI], [VTA]
+- Indeclinable particle
 
 
 ### gloss
@@ -265,7 +265,7 @@ Each head is listed alphabetically (with derivations (phrases on the
 [wordform][]) coming after the 'root' listing).
 
 ### inflected form
-[inflect]: #inflect
+[inflect]: #inflected-form
 [inflected form]: #inflected-form
 [inflected forms]: #inflected-form
 
@@ -581,19 +581,19 @@ same word class behave morphologically in a similar way to each other.
 
 -   **1 or more** [inflectional categories][].
 
+(wc-plains-cree)=
 #### in Plains Cree
 
-[NAD]: #NAD
-[NA]: #NA
-[NID]: #NID
-[NI]: #NI
-[VAI]: #VAI
-[VII]: #VII
-[VTA]: #VTA
-[VTI]: #VTI
+[NI]: #wc-plains-cree
+[NA]: #wc-plains-cree
+[NAD]: #wc-plains-cree
+[NID]: #wc-plains-cree
+[VII]: #wc-plains-cree
+[VAI]: #wc-plains-cree
+[VTI]: #wc-plains-cree
+[VTA]: #wc-plains-cree
 
 These are the word classes in Plains Cree:
-<a id="#NA"></a><a id="#NA"></a><a id="#NAD"></a><a id="#NI"></a><a id="#NID"></a><a id="#VAI"></a><a id="#VII"></a><a id="#VTA"></a><a id="#VTI"></a>
 
 -   NA: 🧑🏽 — **a**nimate **n**oun
 -   NI: 📘 — **i**nanimate **n**oun

docs/requirements.txt

@@ -1,4 +1,4 @@
-myst-parser==0.15.1
+myst-parser==1.0
 
 # include directive parser option is “New in Docutils 0.17”
 # https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment