diff options
| author | David Robillard <d@drobilla.net> | 2023-01-20 15:53:52 -0500 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2023-01-20 15:53:52 -0500 |
| commit | 1f68d229aaa163d9cb42c7784d20a44463066af9 (patch) | |
| tree | 0574d48c078ca90516d8dd6a3d773ec675303729 /README.md | |
| parent | 33d8d2f16109745dd2ea10d7cd800a7909b6300a (diff) | |
| download | pugl-1f68d229aaa163d9cb42c7784d20a44463066af9.tar.gz pugl-1f68d229aaa163d9cb42c7784d20a44463066af9.tar.bz2 pugl-1f68d229aaa163d9cb42c7784d20a44463066af9.zip | |
Replace duplicated dox_to_sphinx script with sphinxygen dependency
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 4 insertions, 3 deletions
@@ -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 ------- |