From 0ce328555ccf4dc1563981d2496e91853f2a1761 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Thu, 6 Jul 2023 09:54:03 +0200 Subject: [PATCH] docs: put changelog in tljh's built documentation under a new reference section --- CHANGELOG.md | 1 + docs/index.md | 12 ++++++++++++ changelog.md => docs/reference/changelog.md | 0 docs/reference/index.md | 10 ++++++++++ 4 files changed, 23 insertions(+) create mode 100644 CHANGELOG.md rename changelog.md => docs/reference/changelog.md (100%) create mode 100644 docs/reference/index.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c49abc5 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1 @@ +The changelog now lives in [TLJH's documentation](https://tljh.jupyter.org/en/stable/reference/changelog.html). diff --git a/docs/index.md b/docs/index.md index dddc39e..fe8dcf7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -53,6 +53,18 @@ Topic guides provide in-depth explanations of specific topics. topic/index ``` +## Reference + +The reference documentation is meant to provide narrowly scoped technical +descriptions that other documentation can link to for details. + +```{toctree} +:maxdepth: 2 +:titlesonly: true + +reference/index +``` + ## Troubleshooting In time, all systems have issues that need to be debugged. Troubleshooting diff --git a/changelog.md b/docs/reference/changelog.md similarity index 100% rename from changelog.md rename to docs/reference/changelog.md diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 0000000..f5dba5d --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,10 @@ +# Reference + +The reference documentation is meant to provide narrowly scoped technical +descriptions that other documentation can link to for details. + +```{toctree} +:titlesonly: true + +changelog +```