From 917bca0c3f1c412efb2dd1f81fc95335ba543352 Mon Sep 17 00:00:00 2001 From: Artem Konev Date: Fri, 4 Oct 2024 15:36:33 +0100 Subject: [PATCH 1/2] add discourse category to conf.py --- sp-files/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/sp-files/conf.py b/sp-files/conf.py index 0eefa2bb..e1a40a20 100644 --- a/sp-files/conf.py +++ b/sp-files/conf.py @@ -119,12 +119,14 @@ # Your Discourse instance URL # - # TODO: Change to your Discourse instance URL or leave empty. + # TODO: Change to your Discourse instance URL and category or leave empty. + # The default setting becomes https://discourse.ubuntu.com/c/desktop/ # # NOTE: If set, adding ':discourse: 123' to an .rst file # will add a link to Discourse topic 123 at the bottom of the page. 'discourse': 'https://discourse.ubuntu.com', + 'category': 'desktop', # Your Mattermost channel URL From 780029c6c5b94725205f1b01aed7a99e369228fc Mon Sep 17 00:00:00 2001 From: Artem Konev Date: Wed, 9 Oct 2024 09:31:14 +0100 Subject: [PATCH 2/2] Makefile: run clean-doc before spelling This addresses canonical/sphinx-docs-starter-pack#225. --- sp-files/Makefile.sp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sp-files/Makefile.sp b/sp-files/Makefile.sp index beaf79df..c924358c 100644 --- a/sp-files/Makefile.sp +++ b/sp-files/Makefile.sp @@ -109,7 +109,7 @@ sp-clean-doc: sp-spellcheck: sp-spellcheck-install . $(VENV) ; python3 -m pyspelling -c $(SPHINXDIR)/spellingcheck.yaml -j $(shell nproc) -sp-spelling: sp-html sp-spellcheck +sp-spelling: sp-clean-doc sp-html sp-spellcheck sp-linkcheck: sp-install . $(VENV) ; $(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) || { grep --color -F "[broken]" "$(BUILDDIR)/output.txt"; exit 1; }