Update the documentation's documentation
This commit is contained in:
parent
096622fb56
commit
d0318ffca4
1 changed files with 31 additions and 5 deletions
|
@ -15,7 +15,7 @@ We like [Gitlab's approach](https://about.gitlab.com/handbook/git-page-update/#w
|
||||||
|
|
||||||
Somewhere is better than nowhere.
|
Somewhere is better than nowhere.
|
||||||
|
|
||||||
Don't worry about [translation](translation).
|
Don't worry about [translation](translation.md).
|
||||||
|
|
||||||
## Guidelines
|
## 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.
|
* Topics which are of general application can be abstracted, put in this repository, and linked to at this documentation.
|
||||||
|
|
||||||
```{note}
|
```{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
|
```bash
|
||||||
sudo apt install python3-sphinx
|
sudo apt install python3-sphinx
|
||||||
pip3 install -r requirements.txt
|
pip3 install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
### Generating
|
#### Generating
|
||||||
|
|
||||||
Running this documentation locally:
|
Running this documentation locally:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sphinx-build -b html . _build/html
|
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
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue