From d0318ffca47fd8eb97eb1c65e327d67c50c801c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?benjamin=20melan=C3=A7on?= Date: Tue, 2 Apr 2024 02:47:48 -0400 Subject: [PATCH] Update the documentation's documentation --- documentation.md | 36 +++++++++++++++++++++++++++++++----- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/documentation.md b/documentation.md index 140a87c..a09ace1 100644 --- a/documentation.md +++ b/documentation.md @@ -15,7 +15,7 @@ We like [Gitlab's approach](https://about.gitlab.com/handbook/git-page-update/#w Somewhere is better than nowhere. -Don't worry about [translation](translation). +Don't worry about [translation](translation.md). ## Guidelines @@ -25,22 +25,48 @@ Don't worry about [translation](translation). * Topics which are of general application can be abstracted, put in this repository, and linked to at this documentation. ```{note} -In doing documentation we are living our [values](values) of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships. +In doing documentation we are living our [values](values.md) of encouraging continuous learning, appreciating new ideas, giving back to the communities we are part of, and valuing long-term relationships. ``` -## Local preview +## This documentation -### Setup +### Local preview + +#### Setup ```bash sudo apt install python3-sphinx pip3 install -r requirements.txt ``` -### Generating +#### Generating Running this documentation locally: ```bash sphinx-build -b html . _build/html ``` + +### Useful examples + +#### Including the table of contents of another page + +``` +```{toctree} +--- +caption: See also +--- + +copyright-and-trademarks +``` +``` + +Produces this: + +```{toctree} +--- +caption: See also +--- + +copyright-and-trademarks +```