Merge pull request #1527 from plone/linkcheck-news-volto

Fix Sphinx toctree warnings from included CHANGELOG.md

Author: stevepiercy

Makefile

@@ -58,6 +58,7 @@ docs/volto:
 	git submodule init; \
 	git submodule update; \
 	ln -s ../submodules/volto/docs/source ./docs/volto
+	ln -s ../submodules/volto/docs/source/news ./docs/volto/news
 	@echo
 	@echo "Documentation of volto initialized."
 

docs/conf.py

@@ -93,6 +93,7 @@
     r"https://docs.cypress.io/guides/references/migration-guide#Migrating-to-Cypress-version-10-0",  # volto
     # Ignore unreliable sites
     r"https://web.archive.org/",  # volto
+    r"https://www.youtube.com/playlist",  # volto, TODO remove after installing sphinxcontrib.youtube
 ]
 linkcheck_anchors = True
 linkcheck_timeout = 5
@@ -128,6 +129,11 @@
     "volto/contributing/branch-policy.md",
 ]
 
+suppress_warnings = [
+    # "toc.excluded",  # Suppress `WARNING: document isn't included in any toctree`
+    "toc.not_readable",  # Suppress `WARNING: toctree contains reference to nonexisting document 'news*'`
+]
+
 html_js_files = ["patch_scrollToActive.js", "search_shortcut.js"]
 
 html_extra_path = [