Bartosz Golaszewski
e4427590d9
doc: integrate rust docs into the sphinx build
...
Follow the pattern we established with GLib bindings: generate a separate
set of docs for the rust bindings, make them part of the generated doc
bundle and point to the rust index.html from the dedicated sphinx page.
Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org >
Reviewed-by: Erik Schilling <erik@riscstar.com >
Link: https://lore.kernel.org/r/20250605-rust-docs-v2-3-883a0a3872c0@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-06-10 09:43:03 +02:00
Bartosz Golaszewski
4b779774db
doc: improve the readability of the prefix variable
...
Currently the default value for prefix - indicating the current
directory - is an empty string. This means that if we do
"{prefix}/foo", we may end up pointing to the root directory which is
not what we want. Make "./" be the default value so that the example
becomes valid and add "/" where we couldn't do it before.
Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org >
Reviewed-by: Erik Schilling <erik@riscstar.com >
Link: https://lore.kernel.org/r/20250605-rust-docs-v2-2-883a0a3872c0@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-06-10 09:43:03 +02:00
Bartosz Golaszewski
1c4199e56b
doc: reformat conf.py with black
...
There's one missing newline according to black so add it.
Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org >
Reviewed-by: Erik Schilling <erik@riscstar.com >
Link: https://lore.kernel.org/r/20250605-rust-docs-v2-1-883a0a3872c0@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-06-10 09:43:03 +02:00
Bartosz Golaszewski
2cd1efbc57
doc: clarify the differences between building from git and tarballs
...
Several users reported having trouble understanding the "building"
section of the docs and being confused on whether they should use
autogen.sh or configure. Clarify these bits in the docs.
Link: https://lore.kernel.org/r/20250311140147.66484-1-brgl@bgdev.pl
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-03-13 09:21:47 +01:00
Bartosz Golaszewski
7439b03e9c
doc: add missing .rst files to EXTRA_DIST
...
Several .rst files are not bundled in distro tarballs. Add them to
EXTRA_DIST.
Fixes: dda57bd63fbartosz.golaszewski@linaro.org >
2025-02-19 12:56:39 +01:00
Bartosz Golaszewski
dda57bd63f
doc: move README contents to sphinx docs
...
We now have comprehensive documentation available online on readthedocs.
Let's not duplicate docs in README - move all information into the
sphinx files.
While at it: make the remaining README use markdown.
Reviewed-by: Vincent Fazio <vfazio@xes-inc.com >
Link: https://lore.kernel.org/r/20250211-improve-docs-v4-17-dc56702c2ca8@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-02-17 09:18:27 +01:00
Bartosz Golaszewski
bbcb5d4461
doc: add documentation for D-Bus API, daemon and command-line client
...
Use the man pages for gpio-manager and gpiocli + some manual labor to
provide sphinx docs for the libgpiod D-Bus API.
Reviewed-by: Vincent Fazio <vfazio@xes-inc.com >
Link: https://lore.kernel.org/r/20250211-improve-docs-v4-16-dc56702c2ca8@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-02-17 09:18:24 +01:00
Bartosz Golaszewski
6f8b77c712
doc: add documentation for gpio-tools
...
We already generate man pages for gpio-tools. Let's use man2html to make
them part of the sphinx docs.
Reviewed-by: Vincent Fazio <vfazio@xes-inc.com >
Link: https://lore.kernel.org/r/20250211-improve-docs-v4-15-dc56702c2ca8@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-02-17 09:18:22 +01:00
Bartosz Golaszewski
f37aaf2a6a
doc: add documentation for GLib bindings
...
The GObject docs are generated with gi-docgen and there doesn't seem to
be an easy way of converting them to sphinx. Let's put the GLib docs
statically into the sphinx output and reference them from the bindings
chapter.
Reviewed-by: Vincent Fazio <vfazio@xes-inc.com >
Link: https://lore.kernel.org/r/20250211-improve-docs-v4-14-dc56702c2ca8@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-02-17 09:18:20 +01:00
Bartosz Golaszewski
07da462186
doc: add documentation for python bindings
...
Integrate python docs with sphinx using autodoc and the import mock
feature which allows us to avoid having to build the C extension.
Reviewed-by: Vincent Fazio <vfazio@xes-inc.com >
Link: https://lore.kernel.org/r/20250211-improve-docs-v4-13-dc56702c2ca8@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-02-17 09:18:16 +01:00
Bartosz Golaszewski
7e11886fff
doc: provide sphinx docs for the core C API and C++ bindings
...
Current sphinx/ contents are mostly WiP. Let's beat them into shape for
publishing on ReadTheDocs.
Integrate the API documentation generated with doxygen for the core C
API and C++ bindings into sphinx using breathe.
Update configure.ac to check for sphinx-build in addition to doxygen and
make the main Makefile trigger a sphinx build on `make doc` (although
the docs can also be generated without starting the build system by
running: `sphinx-build ./docs/ docs/sphinx-output`).
Move the introduction text from the main header into the relevant .rst
file.
Remove obsolete Doxyfile.in and create a static Doxygen under doc/ where
all the documentation now lives.
Update .gitignore where needed.
Reviewed-by: Vincent Fazio <vfazio@xes-inc.com >
Link: https://lore.kernel.org/r/20250211-improve-docs-v4-12-dc56702c2ca8@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org >
2025-02-17 09:18:11 +01:00
