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/c/index.rst     |  9 +++++++--
 doc/c/overview.rst  |  8 ++++++++
 doc/c/reference.rst | 18 ------------------
 doc/c/wscript       |  7 ++-----
 4 files changed, 17 insertions(+), 25 deletions(-)
 delete mode 100644 doc/c/reference.rst

(limited to 'doc/c')

diff --git a/doc/c/index.rst b/doc/c/index.rst
index 6f046de..020cf32 100644
--- a/doc/c/index.rst
+++ b/doc/c/index.rst
@@ -1,6 +1,11 @@
+####
+Pugl
+####
+
+.. include:: summary.rst
+
 .. toctree::
 
-   pugl
    deployment
    overview
-   reference
+   api/pugl
diff --git a/doc/c/overview.rst b/doc/c/overview.rst
index f597aab..4bd024d 100644
--- a/doc/c/overview.rst
+++ b/doc/c/overview.rst
@@ -9,6 +9,12 @@ The Pugl API revolves around two main objects: the `world` and the `view`.
 An application creates a world to manage top-level state,
 then creates one or more views to display.
 
+The core API (excluding backend-specific components) is declared in ``pugl.h``:
+
+.. code-block:: c
+
+   #include <pugl/pugl.h>
+
 .. toctree::
 
    world
@@ -16,3 +22,5 @@ then creates one or more views to display.
    events
    event-loop
    shutting-down
+
+.. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config/
diff --git a/doc/c/reference.rst b/doc/c/reference.rst
deleted file mode 100644
index 21a187f..0000000
--- a/doc/c/reference.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-#############
-API Reference
-#############
-
-This section contains the generated documentation for all symbols in the public
-API.
-
-.. toctree::
-
-   api/status
-   api/world
-   api/view
-   api/events
-
-   api/cairo
-   api/gl
-   api/stub
-   api/vulkan
diff --git a/doc/c/wscript b/doc/c/wscript
index 389c43f..dc97f6e 100644
--- a/doc/c/wscript
+++ b/doc/c/wscript
@@ -6,15 +6,12 @@ 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"),
+        ("../summary.rst", "sphinx/summary.rst"),
         ("event-loop.rst", "sphinx/event-loop.rst"),
         ("events.rst", "sphinx/events.rst"),
         ("index.rst", "sphinx/index.rst"),
         ("overview.rst", "sphinx/overview.rst"),
-        ("reference.rst", "sphinx/reference.rst"),
         ("shutting-down.rst", "sphinx/shutting-down.rst"),
         ("view.rst", "sphinx/view.rst"),
         ("world.rst", "sphinx/world.rst"),
@@ -44,5 +41,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 + "c/singlehtml/")
-- 
cgit v1.2.1