From d08e71811d0d562d332f7b66f39e089eae2a292f Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Wed, 27 Sep 2023 21:28:07 -0500 Subject: [PATCH] Add table of contents to the doc's readme --- doc/README | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/README b/doc/README index 029948c..a45b25d 100644 --- a/doc/README +++ b/doc/README @@ -36,3 +36,31 @@ explains the real-world implications of the rule. (Likewise with error messages generated by the database's rules themselves. Without knowing what the problem is in terms of rows and columns it is not clear, operationally, how to fix a rule violation.) + + +Content: + +INPUT +conf.py Sphinx configuration file +diagrams/ Diagram (Inkscape) source files; Edit these +include/ m4 used only by the documentation builder +src/ The m4 which becomes RST; Edit this tree +_static The root of the Sphinx static content dirs + +OUTPUT +sokwedbtechnical_a4.pdf Made by `make doc/sokwedbtechnical_a4.pdf` +sokwedbtechnical_letter.pdf Made by `make doc/sokwedbtechnical_letter.pdf` +sphinx-doc/ Made input to Sphinx; Sphinx output in "build/" + +TOOLS +extract_view.py Filters view SQL, outputs the body of the view +find_footnotes Utility to aid unique footnote numbering + +DATA +README This document +requirements.txt Makes sphinx-venv/ reproducable; See `make` +sphinx-venv/ Made and managed by make; See `make` + +Sphinx (sphinx-build 7.1.0) requires, at least by convention and +default, that the following be in the same directory: conf.py, +sphinx-doc/, _static -- 2.34.1