Commit graph

9 commits

Author SHA1 Message Date
Peter Hutterer
9ed9980fa2 doc: change the tutorials to doxygen sources
While doxygen can handle markdown pages, support for it is very limited:
markdown pages can only be included as a whole page, they get an automatic
title (custom titles are possible but aren't standard markdown) and it's not
possible to use \subpage without messing with the markdown again. Any markdown
page will thus end up as separate item in the doxygen output, not really
suitable for generating a good page hiearchy.

Let's switch the tutorial to use doxygen directly instead of markdown, short
of using code/endcode instead of markdown's ``` there isn't that much
difference anyway but it allows us to structure things nicer in the online
docs.
2021-05-26 10:02:10 +02:00
Peter Hutterer
fce28ac59b doc: remove duplicate tutorial reference 2021-05-26 10:02:10 +02:00
Peter Hutterer
f8243f3cc1 doc: move spa/foo.md to spa-foo.md
Flatten the hierarchy a bit to make it easier to handle.
2021-05-26 10:02:10 +02:00
Peter Hutterer
ac05f6bb03 doc: add the various markdown prose docs to the doxygen output
Note that the order of the includes matters - that's how doxygen will sort
them. There is no specific structure other than the include order - one reason
why the headers are being changed. Without polluting the markdown files with
doxygen commands we cannot use \subpage, so all files convert to a regular
\page and are listed as flat hierarchy in the sidebar (and in Related Pages).

Changing the headers at least provides some visual grouping with comon
prefixes.
2021-05-07 10:27:26 +10:00
Emmanuel Gil Peyrot
14fdf07e8f Run codespell on the entire codebase
This tool detects and fixes common English spelling mistakes, with
generally very few mistakes.

Here is the command I used to generate this commit.  There were a few
changes that had to be done manually, and of course adding the ignore
file:
```shell
codespell -I .codespell-ignore -x .codespell-ignore -w
```

I didn’t add it to the CI, but this would be a good place for it.
2020-08-17 17:16:31 +00:00
Wim Taymans
205c4a58f9 doc: fix navigation 2020-06-11 16:38:26 +02:00
Wim Taymans
4d3647acbb doc: add cleanup 2020-06-11 16:36:55 +02:00
Wim Taymans
00ca566b18 doc: cleanups 2020-06-11 16:30:27 +02:00
Wim Taymans
9b245da5c0 docs: add tutorial 3 2020-06-11 16:25:47 +02:00