chore: merge branch 'main' into 'dev'

CHANGELOG.md

@@ -1,5 +1,21 @@
 # sphinx-docs-starter-pack changelog
 
+## Upcoming
+
+* Remove scripts and references to unused HTML metrics.
+* Pin myst-parser package version to 4.0 to avoid conflicts.
+
+### Changed
+
+* `docs/requirements.txt` [#496](https://github.com/canonical/sphinx-docs-starter-pack/pull/496)
+* `docs/Makefile` [#490](https://github.com/canonical/sphinx-docs-starter-pack/pull/490)
+* `docs/.sphinx/update_sp.py` [#490](https://github.com/canonical/sphinx-docs-starter-pack/pull/490)
+
+### Removed
+
+* `docs/.sphinx/metrics/build_metrics.py` [#490](https://github.com/canonical/sphinx-docs-starter-pack/pull/490)
+* `docs/.sphinx/metrics/source_metrics.sh` [#490](https://github.com/canonical/sphinx-docs-starter-pack/pull/490)
+
 ## 1.3.1
 
 * Switches doc links to `stable` slug.

docs/.sphinx/update_sp.py

@@ -230,7 +230,7 @@ def get_local_files_and_paths():
     try:
         files = []
         paths = []
-        patterns = [".*", "**.*", "metrics/**.*"]
+        patterns = [".*", "**.*"]
         files, paths = [], []
 
         for pattern in patterns:

docs/Makefile

@@ -13,7 +13,6 @@ VENVDIR         ?= $(SPHINXDIR)/venv
 PA11Y           = $(SPHINXDIR)/node_modules/pa11y/bin/pa11y.js --config $(SPHINXDIR)/pa11y.json
 VENV            = $(VENVDIR)/bin/activate
 TARGET          = *
-METRICSDIR      = $(SOURCEDIR)/.sphinx/metrics
 REQPDFPACKS     = latexmk fonts-freefont-otf texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-font-utils texlive-lang-cjk texlive-xetex plantuml xindy tex-gyre dvipng
 CONFIRM_SUDO    ?= N
 VALE_CONFIG     = $(SPHINXDIR)/vale.ini
@@ -39,14 +38,13 @@ help:
 	@echo "* check accessibility:                       make pa11y"
 	@echo "* check style guide compliance:              make vale"
 	@echo "* check style guide compliance on target:    make vale TARGET=*"
-	@echo "* check metrics for documentation:           make allmetrics"
 	@echo "* other possible targets:                    make <TAB twice>"
 	@echo "-------------------------------------------------------------"
 	@echo
 
 .PHONY: help full-help html epub pdf linkcheck spelling spellcheck woke \
         vale pa11y run serve install pa11y-install   \
-        vale-install pdf-prep pdf-prep-force clean clean-doc allmetrics \
+        vale-install pdf-prep pdf-prep-force clean clean-doc \
         update lint-md
 
 full-help: $(VENVDIR)
@@ -165,16 +163,6 @@ pdf: pdf-prep
 	@echo "Output can be found in ./$(BUILDDIR)"
 	@echo
 
-allmetrics: html
-	@echo "Recording documentation metrics..."
-	@echo "Checking for existence of vale..."
-	. $(VENV)
-	@. $(VENV); test -d $(VALEDIR) || pip install vale
-	@. $(VENV); test -f $(VALE_CONFIG) || python3 $(SPHINXDIR)/get_vale_conf.py
-	@. $(VENV); find $(VALEDIR)/vale_bin -size 195c -exec vale --config "$(VALE_CONFIG)" $(TARGET) > /dev/null \;
-	@eval '$(METRICSDIR)/source_metrics.sh $(PWD)'
-	@. $(VENV); python3 $(METRICSDIR)/build_metrics.py $(BUILDDIR)
-
 update: install
 	@. $(VENV); .sphinx/update_sp.py
 

docs/how-to/migrate-from-pre-extension.rst

@@ -173,8 +173,8 @@ Assuming that all previous documentation files were in the ``docs/`` sub-directo
     │   ├── latex_elements_template.txt     # removed, now part of the extension
     │   ├── pa11y-ci.json           # renamed to `pa11y.json`
     │   └── spellingcheck.yaml
-    ├── metrics                     # moved to `docs/.sphinx/metrics/`
-    │   └── scripts                 # removed, files moved to parent directory
+    ├── metrics                     # removed
+    │   └── scripts                 
     │       ├── build_metrics.sh   
     │       └── source_metrics.sh   
     ├── reuse                       # moved to `docs/reuse`

docs/requirements.txt

@@ -2,7 +2,7 @@
 canonical-sphinx>=0.5.1
 
 # Extensions previously auto-loaded by canonical-sphinx
-myst-parser
+myst-parser~=4.0    # v5.0.0 causes version conflicts
 sphinx-autobuild
 sphinx-design
 sphinx-notfound-page