Skip to content

Commit

Permalink
adjust headings
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Sep 23, 2023
1 parent 2a5a56d commit 4cde722
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions content/sphinx.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
- Create example Sphinx documentation and learn some Markdown along the way.
```

## Group exercise: Build Sphinx documentation using Markdown

We will take the first steps in creating documentation using Sphinx, and learn some
MyST flavored Markdown syntax along the way.

Expand Down Expand Up @@ -66,7 +64,7 @@ please follow our
````


### Exercise: Sphinx basics
## Exercise: Sphinx basics

````{exercise} Sphinx-1: Generate the basic documentation template
Expand Down Expand Up @@ -252,8 +250,7 @@ Note that you can change the styling by editing `conf.py` and changing the value
````



### Exercise: Sphinx content
## Exercise: Sphinx content

````{exercise} Sphinx-2: Add content to your example documentation
Expand Down Expand Up @@ -349,7 +346,7 @@ Note, that this will not resolve e.g. image paths within README.md, use experime
````


### Exercise: Sphinx LaTeX
## Exercise: Sphinx and LaTeX

````{exercise} (optional) Sphinx-3: Rendering (LaTeX) math equations
Expand Down Expand Up @@ -453,7 +450,8 @@ every time you save a file - which makes writing and testing much easier.

---

### Where to find more
## Where to find more

- [Sphinx documentation](https://www.sphinx-doc.org/)
- [Sphinx + ReadTheDocs guide](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html)
- For more Markdown functionality, see the [Mardown guide](https://www.markdownguide.org/basic-syntax/).
Expand Down

0 comments on commit 4cde722

Please sign in to comment.