The docs can be found published via Github pages at:
These docs are to be generated using the Spinx Python static HTML site generator, in a Celbridge project (dogfooding :-):
-
clone repo locally
-
open project in the Celbridge application
-
at the console 'cd' into the
/docsfolder:>>> %cd docs -
use MAKE to clean any previous generated docxs with a clean build
>>> !make clean -
use MAKE to build a new set of docs in direcotry
_build>>> !make html -
run a webserver, to serve up the contents of
/docs/_build/html
I got the Sphinx Github Actions to work thanks to this resource from Shengyu Zhang:
