This repo no longer stores copies of related documentation from the other repositories used to build the doc suite. Instead, that documentation is cloned on demand from each relevant repo as part of the build process.
rsync is used rather than cp to stage files into the docs directory before commiting and pushing to GitHub. This ensures that new files are automatically added and obsolete files are automatically pruned from the published docs, provided the git add -A is used prior to committing the generated files.
A script commit.sh has been added to perform the git add/commit/publish sequence to ensure consistent behavior when publishing the generated documentation artifacts.
This PR refactors the
sphinx
-based documentation build process so that it can be fully automated. A docker container image definition is located at https://github.com/informatics-isi-edu/deriva-docs-docker.Major changes:
rsync
is used rather thancp
to stage files into thedocs
directory before commiting and pushing to GitHub. This ensures that new files are automatically added and obsolete files are automatically pruned from the published docs, provided thegit add -A
is used prior to committing the generated files.commit.sh
has been added to perform thegit
add/commit/publish sequence to ensure consistent behavior when publishing the generated documentation artifacts.