Add option to include Mkdocs skeleton and GitHub workflow #68
Conversation
This file contains 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
alexdewar
force-pushed
the
mkdocs
branch
3 times, most recently
from
e0b87a3 to
e4fd0ce
Compare
alexdewar
requested review from
dalonsoa,
cc-a and
AdrianDAlessandro
as code owners
AdrianDAlessandro
requested changes
Aug 7, 2024
Co-authored-by: Adrian D'Alessandro <[email protected]>
Co-authored-by: Adrian D'Alessandro <[email protected]>
|
@AdrianDAlessandro I decided to go with your suggestion of building the docs only on release. I think that's probably a more sensible default and users can always tweak it later if they want. |
AdrianDAlessandro
approved these changes
Aug 12, 2024
|
Thanks 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Most of this was copied from other places where we use these config files, so hopefully there's nothing too controversial here.
I've added an option to add a MkDocs skeleton along with a GitHub workflow to deploy it to GitHub Pages (using the new workflow, like we do with the blog). Annoyingly, it seems like you can't have some prompts that depend on others with
cookiecutter, so users have to either take the lot or nothing at all. Oh well.I also removed some irrelevant parts of the README for
pip-toolsprojects and enabled caching for Python packages with GitHub Actions.Closes #61.