George Kiagiadakis
2bd0c1b687
docs: relax doxygen version requirement
...
1.8.x also works just fine
2021-06-28 17:36:47 +03:00
George Kiagiadakis
48ef823318
meson: avoid source_root(), as it fails when wireplumber is a subproject
2021-06-16 19:44:43 +03:00
George Kiagiadakis
f9767d19a6
lib: add struct paddings to be able to maintain ABI compatibility
...
Aim for 8 pointers on each struct, wich exceptions:
- 12 pointers for already crowded/important ones
- 4 pointers for empty ones that are used for proxies; we are
unlikely to add any virtual methods on these classes ever
2021-06-08 17:38:14 +03:00
George Kiagiadakis
72297e0909
docs: set breathe_default_members to get struct members to show up in the docs
...
Otherwise structs do not have any members shown by default.
This was accidentally removed in an older commit.
2021-06-08 17:14:54 +03:00
George Kiagiadakis
06c0e44609
docs: remove :project: annotations for breathe
...
there is a breathe_default_project in conf.py.in that sets this
2021-06-08 17:12:26 +03:00
Jason Francis
d9cd0e4fdf
docs: Write gtk-doc comments for constant variables
2021-06-02 17:38:34 +00:00
Jason Francis
1b5df6096a
docs: include wp.h in gir sources
2021-06-02 17:38:34 +00:00
George Kiagiadakis
9db0e741cd
lua: allow the Log api to debug boxed objects (useful for pods)
2021-06-02 19:38:51 +03:00
George Kiagiadakis
132de309cb
lua: fix PipewireObject api: s/set_params/set_param/ and cleanup
2021-06-02 19:38:51 +03:00
George Kiagiadakis
ec7541e840
docs: make progress on lua api documentation
2021-05-28 19:22:56 +03:00
George Kiagiadakis
f038666399
meson: add reference to bugfix
...
so that we can safely remove our hack in the future, when we
will be able to depend on the next version of meson
2021-05-28 17:42:16 +03:00
George Kiagiadakis
bfbe97c8b3
meson: force the gir target to depend on wp-gtkdoc.h
...
With a hacky workaround, because the generate_gir() implementation
has a bug and does not pass the file dependencies properly down
to the custom_target() that it creates internally
2021-05-26 21:22:24 +03:00
George Kiagiadakis
5d7cdfabec
docs: tidy up most documents and try to update the information in them
...
- use code blocks properly
- use note/important blocks
- stop using ` for emphasis, use `` or * appropriately
- update info on contributing, community, running, logging
2021-05-26 19:20:05 +03:00
George Kiagiadakis
f2d4ed17da
docs: use the default sidebar color to make the version easier to read
2021-05-26 15:59:41 +03:00
George Kiagiadakis
fa6db589da
docs: show version number on the sidebar
2021-05-26 15:58:40 +03:00
George Kiagiadakis
8b340a5705
docs: convert NEWS to rst and add it in the generated docs
2021-05-26 09:30:06 +03:00
George Kiagiadakis
87403eb1d4
docs: update installing-wireplumber page
2021-05-25 15:01:43 +03:00
George Kiagiadakis
cdcb38e4e6
gir: fix generate_gir()
...
The path to libwireplumber-0.4.so is not set otherwise and the
linker cannot find it
2021-05-25 14:19:53 +03:00
George Kiagiadakis
e567637d37
docs: convert lua api docs to pure rst
...
Not all the docs are there yet, this is WIP
2021-05-25 14:19:53 +03:00
George Kiagiadakis
c3ee52506b
docs: fix gobject-introspection data generation
...
Let g-ir-scanner parse the original headers for the C signatures
and just add the gtk-doc comments in the generated wp-gtkdoc.h file
Also cleanup a bit gen-api-gtkdoc.py and make it omit printing most of the
whitespace clutter that it used to print inside the gtk-doc comments
2021-05-25 14:19:53 +03:00
George Kiagiadakis
fb77a9fcc7
docs: improve the home page and toc; use README.rst as a base; add badges
2021-05-25 14:19:53 +03:00
George Kiagiadakis
b812e912d2
docs: fix C API documentation to work nicely with doxygen & sphinx
2021-05-25 14:19:53 +03:00
George Kiagiadakis
7f54533185
docs: meson: rebuild docs when Doxyfile.in changes
2021-05-25 14:19:53 +03:00
George Kiagiadakis
0c8ef5f2c7
docs: setup sphinx to use the graphviz extension
2021-05-25 14:19:53 +03:00
George Kiagiadakis
32200da516
docs: improve the visual appearence of the generated html and cleanup
2021-05-25 14:19:53 +03:00
George Kiagiadakis
2eac6257d8
docs: reorganize .rst files and add tables of contents for the APIs
2021-05-25 14:19:53 +03:00
George Kiagiadakis
93c2e7d686
meson: refactor docs + gi build system
...
* Use custom_target() instead of configured shell scripts
* Do not copy all the .rst files in the build directory
* Setup dependencies between targets
* Tidy up dependencies lookup
* Remove unused files
* Upgrade Doxyfile to the latest version and cleanup used options
2021-05-25 14:19:53 +03:00
Raghavendra
2e5b13f970
docs: build gobject introspection from xml files generated by Doxygen
2021-05-25 14:19:53 +03:00
Raghavendra
80e7b20a73
docs: Add Lua API documentation
2021-05-25 14:19:53 +03:00
Raghavendra
d692f06f0d
docs: api: Replace hotdoc specific commands with Doxygen specific commands
2021-05-25 14:19:53 +03:00
Raghavendra
89549247f8
docs: Replace hotdoc with Doxygen & Sphinx to generate documentation
2021-05-25 14:19:53 +03:00
Julian Bouzas
340213272e
m-si-adapter: rename to si-audio-adapter
...
Because it is only meant to be used with audio nodes
2021-03-18 14:47:22 -04:00
George Kiagiadakis
89d300ea48
docs: update daemon/running.md
...
pipewire.conf uses a different format now
2021-01-22 12:51:10 +02:00
George Kiagiadakis
4eb853ca7a
docs: mention that the test SPA plugins are required for unit tests
...
Related to #18
2020-07-20 12:20:53 +03:00
George Kiagiadakis
83c7655267
docs: update configuration.md
2020-06-19 12:09:09 +03:00
George Kiagiadakis
fa6c1a74cb
docs: fix broken link
2020-06-19 10:29:07 +03:00
George Kiagiadakis
3966e046ae
docs: add manual test instructions
2020-06-18 19:21:21 +03:00
George Kiagiadakis
7b5752448d
doc/contributing: add a note about rebasing merge requests
2020-06-15 11:36:15 +03:00
Julian Bouzas
3fa1334113
docs: update configuration.md
2020-05-20 13:14:53 +03:00
George Kiagiadakis
29886ccf74
docs: improve documentation
2020-05-19 17:54:10 +03:00
Julian Bouzas
268f97e7bc
docs: add test examples for pulseaudio, jack and video clients
2020-03-03 13:27:18 -05:00
George Kiagiadakis
f7c0730b7e
docs: enable building html documentation with hotdoc
2020-01-22 17:06:01 +02:00
George Kiagiadakis
1ccc570f3f
docs: add full documentation on WirePlumber's configuration options and files
2019-12-23 18:21:14 +02:00
