doc: create guide subdirectory

Problem: documentation in the top level doc directory is not going to scale out very well. Create a 'guide' subdirectory and move the build and support pages there. Change the spellcheck script so that it spell *.rst in that directory.
garlick · Sep 29, 2023 · 1a01a11 · 1a01a11
1 parent 544f916
commit 1a01a11
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/doc/Makefile.am b/doc/Makefile.am
@@ -394,9 +394,9 @@ EXTRA_DIST = \
 	domainrefs.py \
 	index.rst \
 	index_man.rst \
-	build.rst \
-	support.rst \
-	images/lgplv3-147x51.png \
+	guide/build.rst \
+	guide/support.rst \
+	guide/images/lgplv3-147x51.png \
 	$(RST_FILES) \
 	man1/index.rst \
 	man1/index_general.rst \

diff --git a/doc/build.rst → doc/guide/build.rst b/doc/build.rst → doc/guide/build.rst
diff --git a/doc/images/lgplv3-147x51.png → doc/guide/images/lgplv3-147x51.png b/doc/images/lgplv3-147x51.png → doc/guide/images/lgplv3-147x51.png
diff --git a/doc/support.rst → doc/guide/support.rst b/doc/support.rst → doc/guide/support.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -97,7 +97,7 @@ Table of Contents
 .. toctree::
    :maxdepth: 2
 
-   build
-   support
+   guide/build
+   guide/support
    index_man
    python/index
diff --git a/doc/test/spellcheck b/doc/test/spellcheck
@@ -1,7 +1,7 @@
 #!/bin/bash
 
 if test $man_base_dir; then
-    set ${man_base_dir}/*.rst ${man_base_dir}/man*/*.rst ${man_base_dir}/man*/common/*.rst
+    set ${man_base_dir}/*.rst ${man_base_dir}/guide/*.rst ${man_base_dir}/man*/*.rst ${man_base_dir}/man*/common/*.rst
 fi
 
 if test $# == 0; then