bdf96979fc
doc: include pipewire-pulse modules explanations also on man page
2023-12-09 16:37:03 +02:00
31b7ff58ad
doc: add pw-v4l2.1 and spa-*.1
...
Add manpages for the remaining utilities without one.
2023-12-09 16:36:24 +02:00
80bf28edfd
doc: add pw-reserve.1
2023-12-08 18:59:23 +02:00
9fdf221705
doc: internals/access: update documentation vs current state
...
Update docs to match implementation.
2023-11-29 18:51:35 +02:00
53601d44a6
doc: internal/protocol: explain registry generation and protocol footers
2023-11-25 18:39:25 +02:00
ffa52fdbc1
meson.build: separate options for installing man pages or docs
2023-11-25 00:14:18 +02:00
d0ec322434
meson.build: set install tags on doc/man
...
These are predefined names in meson
2023-11-25 00:13:59 +02:00
c59820493f
docs: add some more doc about the threads
2023-11-23 12:32:35 +01:00
900f653860
docs: add some more docs
2023-11-23 10:21:08 +01:00
0fbcc87314
doc: make all manpages with Doxygen
...
Use (fixed-up) Doxygen manpage output for all program & module manpages.
This also allows formatting the manual pages properly in the HTML docs.
The Markdown pages work properly only with Doxygen >= 1.9.7, older
versions put them to wrong place in the HTML docs.
2023-11-22 20:10:49 +02:00
33a3990c3c
doc: fix xdg-desktop-portal documentation links
2023-11-21 21:25:13 +01:00
c29d4d4ab7
meson.build: make pandoc optional
...
Skip only pandoc-requiring parts if it is not available.
2023-11-21 17:00:45 +00:00
843e733479
doc: add documentation for pipewire-pulse modules
...
Add (minimal) reference documentation for each pipewire-pulse module.
Add some preprocessing to substitute @pulse_module_options@ in docs from
PW_KEY_MODULE_USAGE so the module options don't need to be repeated.
Produce Doxygen docs + generate manpages pipewire-pulse-modules.7,
pipewire-pulse-module-*.7
2023-11-20 08:41:13 +00:00
21854f24a5
doc: generate man-pages also for pipewire modules
...
Use pandoc + some processing to convert Doxygen html output to man
pages.
Requires pandoc & python for building.
Generates manpages: libpipewire-modules.7, libpipewire-module-*.7
2023-11-19 16:39:15 +00:00
77fad4ee13
doc: reorganize files
...
Separate various autogen files from the documentation .dox files.
Rename .dox files to match the intended tree structure.
2023-11-19 16:39:15 +00:00
c77fdb4864
doc: hide useless indices in doxygen output etc. fixes
...
Hide useless paginated indices.
Rename "Related Pages" -> "Pages".
Fix manpage brief description.
Fix file path name stripping.
Move macro listings after enums, so that they're next to functions.
Remove pwtest from docs, it's not API.
Fixup header styles.
2023-11-04 15:22:01 +02:00
27afa39d5d
doc: use b->requested in tutorial4
2023-11-04 14:50:45 +02:00
49668a9b26
doc: fixup some Doxygen autogen issues
...
Don't show page sections in left sidebar, it's confusing.
Rename Modules -> API Reference in sidebar.
Indicate visually the sidebar entries are collapsible.
Fix spa_pod_json grouping.
Move tools page to top level.
Fix page ordering.
2023-11-04 09:45:55 +00:00
43db03909b
ci: ShellCheck preprocessed scripts separately
...
Change the shellcheck job so that we configure the build and check the
preprocessed versions of the scripts, not the bare ones, which might not
be syntactically valid yet.
2023-09-15 08:49:36 +00:00
86bd0eb708
logger: Add a mechanism to force colourised logging
...
This is handy if we want to redirect to a file but have colours to make
manual parsing easier (for example with `less -R`).
2023-08-08 17:13:31 +00:00
96bb44e290
doc/dma-buf: Use references and other small fixes
2023-08-08 07:00:11 +00:00
49bbe1b4e5
doc/dma-buf: Document usage of SPA_VIDEO_FLAG_MODIFIER flags
2023-08-04 01:48:46 +02:00
ce8f2c5d10
modules-vban: add vban sender and receiver
...
Fixes #3380
2023-07-25 18:36:48 +02:00
4b32b1fef0
modules: add example filter
2023-06-27 14:02:38 +02:00
59756a7c5d
examples: fix indent
2023-06-09 17:06:25 +00:00
f9b2df25c7
docs: clarify writefd in transport
2023-06-06 11:02:43 +02:00
c3b01eee97
doc: clarify proxy/resource
2023-06-06 10:54:53 +02:00
2a00b784fa
doc: small improvement
2023-06-06 10:44:39 +02:00
22acf94f7d
docs: add netjack2 manager
2023-06-05 10:44:07 +02:00
fe99990e0f
doc: update with netjack2 driver
2023-05-31 17:38:05 +02:00
3626b1e90e
module-ffado: add docs
2023-05-29 09:19:29 +02:00
3b5fd0bd7a
doc: fix pod sizes
2023-05-23 09:30:36 +02:00
83718f431b
doc: update
2023-05-23 09:19:35 +02:00
b216a2cfb0
doc: Some minor fixups to the scheduling doc
...
s/evenfd/eventfd and some minor formatting.
2023-05-18 14:58:49 -03:00
957470bd9f
doc: add more docs
2023-05-16 16:15:54 +02:00
f5a65a27b0
docs: document some more
2023-05-16 15:44:22 +02:00
4eb64f5a6c
doc: improve formatting
2023-05-16 12:55:48 +02:00
b5224a6844
doc: improve formatting
2023-05-16 12:50:18 +02:00
d7315ee572
docs: add more docs
2023-05-16 12:42:36 +02:00
56f3d0d417
docs: document some more
2023-05-16 12:27:05 +02:00
e759a2feed
doc: document registry events and methods
2023-05-16 11:21:03 +02:00
aad69d22c1
doc: add more docs
2023-05-16 11:01:54 +02:00
fb5c9688a2
doc: fix comment
2023-05-15 12:04:06 +02:00
a9d6807ec1
doc: add some more docs
2023-05-15 11:44:41 +02:00
4a81c17b68
modules: add jackdbus-detect module
...
Loads jack-tunnel based on jackdbus state.
2023-04-30 10:34:19 +02:00
ab0cee29dd
doc: add jack-tunnel to docs
2023-04-27 17:03:10 +02:00
f6d4306a37
doc: mention .conf extension for config files
...
See #3079
2023-04-14 15:51:21 +02:00
0885899b7a
module-rtp: fix docs
2023-03-09 13:14:22 +01:00
e8119cb087
docs: improve docs
2023-03-09 13:14:22 +01:00
c36d9bef38
doc: add custom node bog post by bootlin
2023-03-09 13:13:35 +01:00
Pauli Virtanen
Wim Taymans
tytan652
Jan Alexander Steffens (heftig)
Arun Raghavan
columbarius
Théo Lebrun