From 1f68d229aaa163d9cb42c7784d20a44463066af9 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Fri, 20 Jan 2023 15:53:52 -0500 Subject: Replace duplicated dox_to_sphinx script with sphinxygen dependency --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8132613..f8e9aba 100644 --- a/README.md +++ b/README.md @@ -49,16 +49,17 @@ Documentation ------------- Pugl is a C library that includes C++ bindings. -Each API is documented separately: +The reference documentation refers to the C API: * [C Documentation (single page)](https://lv2.gitlab.io/pugl/c/singlehtml/) * [C Documentation (paginated)](https://lv2.gitlab.io/pugl/c/html/) - * [C++ Documentation (single page)](https://lv2.gitlab.io/pugl/cpp/singlehtml/) - * [C++ Documentation (paginated)](https://lv2.gitlab.io/pugl/cpp/html/) The documentation will also be built from the source if the `docs` configuration option is enabled, and both Doxygen and Sphinx are available. +The C++ documentation is currently a work in progress, for now you will have to +refer to the examples or headers for guidance on using the C++ bindings. + Testing ------- -- cgit v1.2.1