George Kiagiadakis
c2d125b0da
Merge branch 'master' into next
2023-12-23 18:34:00 +02:00
George Kiagiadakis
c4a0f5317e
meson: exclude rst files from being installed with the scripts
...
and add them nicely to the sphinx_files without referencing '..' paths
2023-12-13 16:31:50 +02:00
Tom A. Wagner
bae3381c76
meson: Set correct package version for generated .gir file for gobject introspection
...
Previously the package version used for the gir file was hardcoded and did not change
when the `wireplumber_api_version` definition was changed, which has now been fixed to
use that definition.
2023-12-12 12:13:51 +01:00
George Kiagiadakis
beafcf1ac3
config: install commented-out conf files as examples in /usr/share/doc/wireplumber/examples
2023-11-15 15:44:01 +02:00
Tom A. Wagner
cde0125443
gir: Add pkg-config package name and main header
...
This adds information about the name of the pkg-config package provided by wireplumber
as well as which header a C program needs to include to use the library to the
generated .gir file.
2022-10-29 12:28:20 +02:00
Niklāvs Koļesņikovs
d8365fe33e
meson: adds summary() to auto features
2021-07-05 12:30:49 +03:00
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
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
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
8b340a5705
docs: convert NEWS to rst and add it in the generated docs
2021-05-26 09:30:06 +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
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
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
George Kiagiadakis
29886ccf74
docs: improve documentation
2020-05-19 17:54:10 +03:00
George Kiagiadakis
f7c0730b7e
docs: enable building html documentation with hotdoc
2020-01-22 17:06:01 +02:00