diff options
author | David Robillard <d@drobilla.net> | 2023-01-03 15:16:48 -0500 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2023-01-03 15:16:48 -0500 |
commit | 40659178c04539fe4c70b144592cb0ee25376492 (patch) | |
tree | a8abb2969d3d6c554ced3f815b1976d0306d4374 /doc | |
parent | 01471ca20e877710d6c3d26f3893f22b9eb7d487 (diff) | |
download | pugl-40659178c04539fe4c70b144592cb0ee25376492.tar.gz pugl-40659178c04539fe4c70b144592cb0ee25376492.tar.bz2 pugl-40659178c04539fe4c70b144592cb0ee25376492.zip |
Use globally unique names for documentation groups
This becomes important when the documentation is included in larger projects.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/c/view.rst | 4 | ||||
-rw-r--r-- | doc/conf.py.in | 2 | ||||
-rw-r--r-- | doc/cpp/view.rst | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/doc/c/view.rst b/doc/c/view.rst index 634b736..faf926f 100644 --- a/doc/c/view.rst +++ b/doc/c/view.rst @@ -22,7 +22,7 @@ Configuring the Frame ********************* Before display, -the necessary :doc:`frame <api/frame>` and :doc:`window <api/window>` attributes should be set. +the necessary :doc:`frame <api/pugl_frame>` and :doc:`window <api/pugl_window>` attributes should be set. These allow the window system (or plugin host) to arrange the view properly. For example: @@ -114,7 +114,7 @@ Before being realized, the view must have a backend set with :func:`puglSetBacke The backend manages the graphics API that will be used for drawing. Pugl includes backends and supporting API for -:doc:`Cairo <api/cairo>`, :doc:`OpenGL <api/gl>`, and :doc:`Vulkan <api/vulkan>`. +:doc:`Cairo <api/pugl_cairo>`, :doc:`OpenGL <api/pugl_gl>`, and :doc:`Vulkan <api/pugl_vulkan>`. Using Cairo =========== diff --git a/doc/conf.py.in b/doc/conf.py.in index 1d5923a..b2669be 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -1,7 +1,7 @@ # Project information project = "Pugl" -copyright = "2020, David Robillard" +copyright = "2023, David Robillard" author = "David Robillard" release = "@PUGL_VERSION@" diff --git a/doc/cpp/view.rst b/doc/cpp/view.rst index 1b93379..5366731 100644 --- a/doc/cpp/view.rst +++ b/doc/cpp/view.rst @@ -60,7 +60,7 @@ Configuring the Frame ********************* Before display, -the necessary :doc:`frame <api/frame>` and :doc:`window <api/window>` attributes should be set. +the necessary :doc:`frame <api/puglpp_frame>` and :doc:`window <api/puglpp_window>` attributes should be set. These allow the window system (or plugin host) to arrange the view properly. Derived classes can configure themselves during construction, |