Repository navigation
Publish a documentation site instead of a wiki - #21
Merged
Merged
Conversation
The copier answers switch to add_docs with the wiki off, which brings the docs workflow (GitHub Pages from gh-pages after a green build on main) and the yardang section. Eight pages under docs/src follow the tutorial, how-to, reference and explanation split; the wiki scaffold goes. The README installs from PyPI now that 0.1.0 is released, and links the site. Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
dau-scheduler had the template's wiki scaffold and nothing else. This switches the copier answers to
add_docs: true,add_wiki: false(template f6a9056), which brings the docs workflow that publishesdocs/htmlto GitHub Pages after each green build onmain, the[tool.yardang]section, and the docs lint overdocs/src; the wiki pages and workflow go.Eight pages under
docs/src, written from the code and its docstrings: a tutorial that splits a query end to end, how-tos for measuring host cost, choosing a merge rule, and developing, reference pages for postures, merge rules, and row sources and execution, and one explanation of the three design choices. Every Python block in the tutorial and how-tos runs in order against the installed package. The site builds clean in a fresh venv withyardang[themes](34 pages, autoapi on).The README installs from PyPI now that 0.1.0 is released, drops the placeholder note, and links the site and the pages the way dau-build's does.
After merge: the first docs run creates
gh-pages; Pages is then enabled on that branch and the repository homepage set to https://dau-dev.github.io/dau-scheduler/.