From 94e30b9c3c188dfdf4765f026872f95ea3cfdda2 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Wed, 6 Jan 2021 23:53:32 +0100
Subject: Simplify documentation structure and use LV2 theme
---
doc/cpp/c-reference.rst | 20 --------------------
doc/cpp/cpp-reference.rst | 18 ------------------
doc/cpp/index.rst | 11 ++++++++---
doc/cpp/overview.rst | 1 -
doc/cpp/wscript | 8 ++------
5 files changed, 10 insertions(+), 48 deletions(-)
delete mode 100644 doc/cpp/c-reference.rst
delete mode 100644 doc/cpp/cpp-reference.rst
(limited to 'doc/cpp')
diff --git a/doc/cpp/c-reference.rst b/doc/cpp/c-reference.rst
deleted file mode 100644
index 546e4d3..0000000
--- a/doc/cpp/c-reference.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-###############
-C API Reference
-###############
-
-This section contains the generated documentation for all symbols in the public
-C API.
-It is included here because some C++ wrapper definitions refer to the underlying C symbols,
-but direct use of the C API should not be necessary in C++ applications.
-
-.. toctree::
-
- api/status
- api/world
- api/view
- api/events
-
- api/cairo
- api/gl
- api/stub
- api/vulkan
diff --git a/doc/cpp/cpp-reference.rst b/doc/cpp/cpp-reference.rst
deleted file mode 100644
index 96c523c..0000000
--- a/doc/cpp/cpp-reference.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-#################
-C++ API Reference
-#################
-
-This section contains the generated documentation for all symbols in the public
-C++ API.
-
-.. toctree::
-
- api/statusxx
- api/worldxx
- api/viewxx
- api/eventsxx
-
- api/cairoxx
- api/glxx
- api/stubxx
- api/vulkanxx
diff --git a/doc/cpp/index.rst b/doc/cpp/index.rst
index c3d330e..b11d028 100644
--- a/doc/cpp/index.rst
+++ b/doc/cpp/index.rst
@@ -1,7 +1,12 @@
+####
+Pugl
+####
+
+.. include:: summary.rst
+
.. toctree::
- pugl
deployment
overview
- cpp-reference
- c-reference
+ api/pugl
+ api/puglxx
diff --git a/doc/cpp/overview.rst b/doc/cpp/overview.rst
index 4ffc3da..1928fba 100644
--- a/doc/cpp/overview.rst
+++ b/doc/cpp/overview.rst
@@ -33,4 +33,3 @@ then creates one or more views to display.
view
events
event-loop
- shutting-down
diff --git a/doc/cpp/wscript b/doc/cpp/wscript
index 3ccb8c7..4bef6c2 100644
--- a/doc/cpp/wscript
+++ b/doc/cpp/wscript
@@ -6,12 +6,8 @@ def build(bld):
files = [
("../../resources/pugl.svg", "sphinx/_static/pugl.svg"),
- ("../_static/custom.css", "sphinx/_static/custom.css"),
- ("../_templates/about.html", "sphinx/_templates/about.html"),
("../deployment.rst", "sphinx/deployment.rst"),
- ("../pugl.rst", "sphinx/pugl.rst"),
- ("c-reference.rst", "sphinx/c-reference.rst"),
- ("cpp-reference.rst", "sphinx/cpp-reference.rst"),
+ ("../summary.rst", "sphinx/summary.rst"),
("event-loop.rst", "sphinx/event-loop.rst"),
("events.rst", "sphinx/events.rst"),
("index.rst", "sphinx/index.rst"),
@@ -44,5 +40,5 @@ def build(bld):
bld(features="sphinx",
sphinx_source=bld.path.get_bld().make_node("sphinx"),
sphinx_output_format="singlehtml",
- sphinx_options=["-E", "-q"],
+ sphinx_options=["-E", "-q", "-t", "singlehtml"],
install_path=doc_dir + "cpp/singlehtml/")
--
cgit v1.2.1