From 794c7676f765092554b8a27d3fe66fb1520b9490 Mon Sep 17 00:00:00 2001 From: tmadlener Date: Thu, 21 Dec 2023 14:04:26 +0100 Subject: [PATCH] Switch markdown tag to fix documentation --- CONTRIBUTING.md | 2 +- README.md | 2 +- contents.md | 1 - developing-key4hep-software/README.md | 2 +- how-tos/README.md | 2 +- spack-build-instructions-for-librarians/README.md | 2 +- tutorials/README.md | 2 +- 7 files changed, 6 insertions(+), 7 deletions(-) delete mode 120000 contents.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71b15d2..9fa668e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ conduct][conduct]. [gh-fork-pull]: https://reflectoring.io/github-fork-and-pull/ -```eval_rst +```{eval-rst} .. toctree:: :hidden: diff --git a/README.md b/README.md index 2038e9d..729ced4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Key4hep -```eval_rst +```{eval-rst} .. toctree:: :maxdepth: 3 :includehidden: diff --git a/contents.md b/contents.md deleted file mode 120000 index 42061c0..0000000 --- a/contents.md +++ /dev/null @@ -1 +0,0 @@ -README.md \ No newline at end of file diff --git a/developing-key4hep-software/README.md b/developing-key4hep-software/README.md index 3f3c8fd..9955c43 100644 --- a/developing-key4hep-software/README.md +++ b/developing-key4hep-software/README.md @@ -4,7 +4,7 @@ Sooner rather than later you will find it necessary write code for Key4hep. Thes -```eval_rst +```{eval-rst} .. toctree:: :caption: Contents: diff --git a/how-tos/README.md b/how-tos/README.md index 63df3c1..73e3213 100644 --- a/how-tos/README.md +++ b/how-tos/README.md @@ -5,7 +5,7 @@ certain things within the Key4hep software stack. They are mainly aimed at Key4hep users and are mostly designed to be reference material, rather than [tutorials](https://key4hep.github.io/key4hep-doc/tutorials/README.html). -```eval_rst +```{eval-rst} .. toctree:: :caption: Contents :maxdepth: 1 diff --git a/spack-build-instructions-for-librarians/README.md b/spack-build-instructions-for-librarians/README.md index 240d431..8442280 100644 --- a/spack-build-instructions-for-librarians/README.md +++ b/spack-build-instructions-for-librarians/README.md @@ -11,7 +11,7 @@ source /cvmfs/sw.hsf.org/key4hep/setup.sh In this page, the workflow to create this installation is documented. -```eval_rst +```{eval-rst} .. toctree:: :caption: Contents: diff --git a/tutorials/README.md b/tutorials/README.md index 7f08605..d6fd51e 100644 --- a/tutorials/README.md +++ b/tutorials/README.md @@ -13,7 +13,7 @@ you have the feeling that something is missing, we are also very happy to accept new tutorial suggestions. If you have a tutorial that you would like to add here. -```eval_rst +```{eval-rst} .. toctree:: :caption: Exercises