From b83f6cfed092b84668a6b9d0827498667949b7c8 Mon Sep 17 00:00:00 2001 From: Jean Felder Date: Thu, 13 Jun 2024 10:40:00 +0200 Subject: [PATCH 1/2] conf: Ignore github directory --- conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/conf.py b/conf.py index cf94cffa56b..25e869fea4e 100644 --- a/conf.py +++ b/conf.py @@ -70,6 +70,7 @@ # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [ 'venv', + '.github', 'docs/user_manual/expressions/expression_help/*' ] From 66868a6590cddd9a3edc912ba16aecc896e0f6d9 Mon Sep 17 00:00:00 2001 From: Jean Felder Date: Thu, 13 Jun 2024 10:41:15 +0200 Subject: [PATCH 2/2] conf: Add support for markdown files This adds support to use markdown files to generate the documentation. The existing `rst` files still work and this allows to mix them with markdown files. Both formats coexist without any friction. This way, a contributor can use its favorite format. Besides, markdown syntax is considered easier to write than the rst one. This might attract new contributors to the project. This also introduces a new dependency for markdown parsing: `myst-parser`. See: https://www.sphinx-doc.org/en/master/usage/markdown.html --- conf.py | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/conf.py b/conf.py index 25e869fea4e..e686baf7c99 100644 --- a/conf.py +++ b/conf.py @@ -59,9 +59,15 @@ 'sphinx.ext.extlinks', 'sphinxext.rediraffe', 'sphinx_togglebutton', - 'sphinx_copybutton' + 'sphinx_copybutton', + 'myst_parser' ] +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown' +} + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -71,7 +77,10 @@ exclude_patterns = [ 'venv', '.github', - 'docs/user_manual/expressions/expression_help/*' + 'docs/user_manual/expressions/expression_help/*', + 'README.md', + 'release_process.md', + 'qgis-projects/user_manual/readme.md' ] # -- Internationalisation ----------------------------------------------------