From c4ba158354767b2eeeb9a27f6bbbd30d0b1e5ad8 Mon Sep 17 00:00:00 2001
From: Reinhold Gschweicher <pyro4hell@gmail.com>
Date: Fri, 12 Sep 2025 11:02:41 +0200
Subject: [PATCH] docs: port foo.rst to foo.md

I like to write documentation in MarkDown better than in `*.rst`.

First step is to have new package documentation in MarkDown. So port the
reference `foo.rst` to `foo.md.
---
 docs/conf.py              |  2 +-
 docs/packages/pkg/foo.md  | 22 ++++++++++++++++++++++
 docs/packages/pkg/foo.rst | 21 ---------------------
 3 files changed, 23 insertions(+), 22 deletions(-)
 create mode 100644 docs/packages/pkg/foo.md
 delete mode 100644 docs/packages/pkg/foo.rst

diff --git a/docs/conf.py b/docs/conf.py
index 03474f5bcf..d395ac22fc 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -84,7 +84,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build', '_venv', 'rtfd-css', 'packages/pkg/foo.rst', 'old-wiki']
+exclude_patterns = ['_build', '_venv', 'rtfd-css', 'packages/pkg/foo.md', 'old-wiki']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
diff --git a/docs/packages/pkg/foo.md b/docs/packages/pkg/foo.md
new file mode 100644
index 0000000000..ff5d3a1d7b
--- /dev/null
+++ b/docs/packages/pkg/foo.md
@@ -0,0 +1,22 @@
+```{spelling}
+
+foo
+```
+
+```{index} single: unsorted ; foo
+```
+
+(pkg.foo)=
+
+# foo
+
+-  [Official](https://official_foo)
+-  [Hunterized](https://github.com/cpp-pm/foo)
+-  [Example](https://github.com/cpp-pm/hunter/blob/master/examples/foo/CMakeLists.txt)
+-  Added by [foo_developer](https://github.com/foo_developer) ([pr-N](https://github.com/cpp-pm/hunter/pull/N))
+
+```{literalinclude} /../examples/foo/CMakeLists.txt
+:language: cmake
+:start-after: "# DOCUMENTATION_START {"
+:end-before: "# DOCUMENTATION_END }"
+```
diff --git a/docs/packages/pkg/foo.rst b/docs/packages/pkg/foo.rst
deleted file mode 100644
index 073570cbd7..0000000000
--- a/docs/packages/pkg/foo.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-.. spelling::
-
-    foo
-
-.. index::
-  single: unsorted ; foo
-
-.. _pkg.foo:
-
-foo
-===
-
--  `Official <https://official_foo>`__
--  `Hunterized <https://github.com/cpp-pm/foo>`__
--  `Example <https://github.com/cpp-pm/hunter/blob/master/examples/foo/CMakeLists.txt>`__
--  Added by `foo_developer <https://github.com/foo_developer>`__ (`pr-N <https://github.com/cpp-pm/hunter/pull/N>`__)
-
-.. literalinclude:: /../examples/foo/CMakeLists.txt
-  :language: cmake
-  :start-after: # DOCUMENTATION_START {
-  :end-before: # DOCUMENTATION_END }