Peter Hutterer
079b90bde5
doc: add a custom doxygen theme based on doxygen-awesome
...
Theme from doxygen-awesome-css with custom modifications based on the
pipewire.org website to use the same type of blue, grey, etc.
doxygen-awesome-css is MIT licensed, see
https://github.com/jothepro/doxygen-awesome-css
2021-05-21 16:08:46 +10:00
Peter Hutterer
f47f85bbcb
doc: fix broken references
...
These pages never existed, let's not try to reference them.
2021-05-21 15:04:22 +10:00
Peter Hutterer
f0d3f1f9d2
doc: remove trailing whitespace
...
My vim/git setup wants to fix those on every commit which gets a bit annoying,
let's just remove them: sed -i 's/ *$//g' $(git ls-files doc)
2021-05-07 10:27:26 +10: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
Peter Hutterer
d10381dfc3
dox: keep the doxygen input files as array in meson
...
Keep all files as strings in an array so we can add them to the custom command
input list - this way meson will correctly rebuild documentation on changes.
2021-05-07 10:27:26 +10:00
Peter Hutterer
1fd56a6d26
doc: reduce the Doxyfile to only non-default options
...
This provides a much easier overview of what the actual changes are to
doxygen's default values.
2021-05-07 10:27:26 +10:00
Peter Hutterer
68080ec531
doc: fix a typo
2021-05-07 10:27:26 +10:00
Peter Hutterer
3234037a71
doc/spa: add more markdown tags to render better
2021-05-07 10:27:26 +10:00
Andrea Gelmini
85b136d8ce
Fix typos
...
Signed-off-by: Andrea Gelmini <andrea.gelmini@gelma.net>
2021-04-30 16:27:34 +00:00
Andrea Gelmini
47ef2b6b09
Fix typos
2021-04-30 07:40:20 +00:00
Peter Hutterer
83ed03d4cf
Remove .gitignore files in subdirectories
...
With meson we no longer have generated files messing up the tree, so we no
longer need these files.
2021-04-20 07:10:15 +00:00
Niklāvs Koļesņikovs
4bfa4a3964
doc: add docdir option
...
As patched in Gentoo.
Fixes #1057
2021-04-16 09:26:35 +02:00
Peter Hutterer
223f20709d
meson: replace join_paths(a, b) with a / b
...
More readable and from the meson reference manual:
(since 0.49.0) Using the/ operator on strings is equivalent to calling join_paths.
2021-04-15 06:57:00 +00:00
insop
a9c247bdab
Minor typo fixes
2021-03-13 21:13:01 +00:00
Wim Taymans
0855b1bb4b
doc: add link to LAC 2020 paper
2021-02-12 13:27:38 +01:00
jasker5183
0dad70eb48
Add buffer.md to fix link in tutorial4.md
2021-01-22 14:07:59 +01:00
Léo Stefanesco
7f3a878dd3
Fix typos in architecture.md
2020-12-22 09:15:21 +00:00
Wim Taymans
77791bd427
doc: fix some typos
2020-11-27 17:35:25 +01:00
Wim Taymans
c4aec3ef4e
doc: fix typo
2020-09-19 13:34:33 +02:00
Richard
4be4a0b250
Update overview.md
2020-09-19 10:56:51 +00:00
Siwon Kang
f7b22b934c
doc: fix typos
...
Signed-off-by: Siwon Kang <siwon.kang@daimler.com>
2020-09-14 20:00:59 +02: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
2176874687
doc: fix some spelling errors
2020-08-11 21:24:19 +02:00
Wim Taymans
e71936f870
Improve naming
...
master -> driving
priority_master -> priority_driver
segment_master -> segment_owner
2020-08-06 13:49:33 +02:00
Wim Taymans
edb3968c5c
docs: some small fixes and updates
2020-08-02 20:14:04 +02:00
Wim Taymans
6e2d3feb07
doc: clarify version field in events
2020-07-27 16:47:30 +02:00
Wim Taymans
0f1df5aee5
doc: add tutorial about binding objects
2020-06-23 15:44:01 +02:00
Wim Taymans
9c049f23ae
doc: add video capture tutorial
2020-06-19 16:37:14 +02:00
Wim Taymans
2bcbf62443
docs: add some more links
2020-06-19 13:41:42 +02:00
Wim Taymans
f2245ecbb1
doc: small fix
2020-06-16 12:28:22 +02:00
Wim Taymans
5778de090f
doc: fix some typos
2020-06-13 21:31:32 +02:00
Wim Taymans
5e652612be
doc: add tutorial for pw_stream playback
2020-06-13 21:26:21 +02:00
Wim Taymans
cdda6ca329
doc: add index
2020-06-11 16:52:47 +02: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
Wim Taymans
44efab6c31
docs: more tutorial
2020-06-11 15:32:52 +02:00
Wim Taymans
0ee5feab67
doc: add tutorial index
2020-06-11 13:43:29 +02:00
Wim Taymans
0a84a77a21
add index
2020-06-11 13:39:09 +02:00
Wim Taymans
a33fac9f9a
Update architecture.md
2020-06-11 11:33:29 +00:00
Wim Taymans
70ce1da29c
doc: add some more docs
2020-06-11 13:29:30 +02:00
Wim Taymans
12afb23938
docs: add some more docs
2020-06-11 09:51:32 +02:00
Wim Taymans
b71efadb7a
doc: add some more info
2020-06-10 17:08:12 +02:00
Wim Taymans
2c8292bef0
docs: add some more info
2020-06-09 17:29:40 +02:00
Wim Taymans
8696ad4480
docs: add some doc about SPA design
2020-06-09 17:08:26 +02:00
Wim Taymans
2b7e6e19dc
doc: annotate code block as c
2020-06-09 15:34:02 +02:00
Wim Taymans
9fd6428314
docs: fix some typos
2020-06-09 15:28:26 +02:00
Wim Taymans
8f251fc7d4
docs: add some docs about SPA POD
2020-06-09 09:06:07 +02:00
Wim Taymans
c546167ad3
require meson 0.49
2020-05-20 15:26:35 +02:00
