Add Sphinx for project documentation #1457
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This can be tweaked later, but this should provide a decent 'starting point', for lack of a better term.
So assuming I have this correct, this should be automatically creating the documentation for both
libweasyl
andweasyl
, and when pushed to themain
branch, the added workflow will publish to GitHub Pages.Not quite sure where to add the command to rebuild the HTML; to be honest, the fact that we're abstracting packages into a Docker container is a tad cumbersome, and to get it built as it was, I needed to have a venv on my host via Poetry, and
poetry install --with=docs --sync
to get Sphinx installed to be able to build it. There's probably some little thing I am overlooking, but... I'm hoping this provides a good starting point.