sokwedb
2 years agoAdd images to generated documentation
Karl O. Pinc [Sun, 21 May 2023 16:17:32 +0000 (11:17 -0500)]
Add images to generated documentation

Convert from dia to inkscape.  Drop a symlink to the image dir into
each of the sphinx source directories since sphinx urls are rooted
at the sphinx source directory.

2 years agoFiles used to develop the images on the wiki
Karl O. Pinc [Sun, 14 May 2023 19:40:11 +0000 (14:40 -0500)]
Files used to develop the images on the wiki

2 years agoAdd single-page html output
Karl O. Pinc [Wed, 10 May 2023 21:23:31 +0000 (16:23 -0500)]
Add single-page html output

2 years agoAdd README file
Karl O. Pinc [Wed, 10 May 2023 06:44:37 +0000 (01:44 -0500)]
Add README file

2 years agoAdd license file
Karl O. Pinc [Wed, 10 May 2023 06:42:51 +0000 (01:42 -0500)]
Add license file

2 years agoCreate the document root directory if necessary
Karl O. Pinc [Wed, 10 May 2023 06:04:06 +0000 (01:04 -0500)]
Create the document root directory if necessary

2 years agoUse a workable requirements.txt
Karl O. Pinc [Wed, 10 May 2023 05:50:54 +0000 (00:50 -0500)]
Use a workable requirements.txt

2 years agoWork-around a venv bug that breaks the generated requirements.txt
Karl O. Pinc [Wed, 10 May 2023 05:50:15 +0000 (00:50 -0500)]
Work-around a venv bug that breaks the generated requirements.txt

2 years agoChange URL paths for docs
Karl O. Pinc [Wed, 10 May 2023 03:34:25 +0000 (22:34 -0500)]
Change URL paths for docs

Have a separate dir for html within docs, as is required by the
process that copies the generated html because anything not generated
is removed.  And put the pdf documents in the doc directory.

2 years agoProduce both A4 and US-Letter pdfs
Karl O. Pinc [Wed, 10 May 2023 03:09:55 +0000 (22:09 -0500)]
Produce both A4 and US-Letter pdfs

2 years agoAdd support for different pdf paper size output
Karl O. Pinc [Wed, 10 May 2023 02:27:15 +0000 (21:27 -0500)]
Add support for different pdf paper size output

2 years agoMake pdf generation work
Karl O. Pinc [Wed, 10 May 2023 01:17:15 +0000 (20:17 -0500)]
Make pdf generation work

2 years agoKeep sphinx venv under revision control
Karl O. Pinc [Wed, 10 May 2023 00:55:27 +0000 (19:55 -0500)]
Keep sphinx venv under revision control

2 years agoImprove comments
Karl O. Pinc [Tue, 9 May 2023 23:57:19 +0000 (18:57 -0500)]
Improve comments

2 years agoDisplay page generation time in UTC
Karl O. Pinc [Tue, 9 May 2023 23:39:20 +0000 (18:39 -0500)]
Display page generation time in UTC

2 years agoSeparate target dirs for local and non-local html
Karl O. Pinc [Tue, 9 May 2023 22:11:20 +0000 (17:11 -0500)]
Separate target dirs for local and non-local html

Since local html now uses a html builder but non-local html uses
dirhtml, sharing a target directory results is "extra stuff"
leftover from the other kind of build.  We don't want that.

2 years agoBetter comment
Karl O. Pinc [Tue, 9 May 2023 21:58:04 +0000 (16:58 -0500)]
Better comment

2 years agoNo need for recursive expansion as source files are not dynamic
Karl O. Pinc [Tue, 9 May 2023 21:57:47 +0000 (16:57 -0500)]
No need for recursive expansion as source files are not dynamic

2 years agoBetter comment
Karl O. Pinc [Tue, 9 May 2023 21:54:11 +0000 (16:54 -0500)]
Better comment

2 years agoBetter variable names and comments
Karl O. Pinc [Tue, 9 May 2023 21:44:57 +0000 (16:44 -0500)]
Better variable names and comments

2 years agoGet rid of extra variable
Karl O. Pinc [Tue, 9 May 2023 21:43:36 +0000 (16:43 -0500)]
Get rid of extra variable

2 years agoBetter comments
Karl O. Pinc [Tue, 9 May 2023 21:31:42 +0000 (16:31 -0500)]
Better comments

2 years agoMove generated RST epilog files into doc/sphinx-doc/.
Karl O. Pinc [Tue, 9 May 2023 20:56:23 +0000 (15:56 -0500)]
Move generated RST epilog files into doc/sphinx-doc/.

2 years agoBuild system for text docs -- images not yet supported
Karl O. Pinc [Tue, 9 May 2023 16:49:33 +0000 (11:49 -0500)]
Build system for text docs -- images not yet supported