Set up hexdoc plugin for web book (1.20.1) #130
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
Squashed commits: - Fix versioning - Add version explanation comments - forgot to git add - Add hatch-gradle-version - Update hatch-gradle-version - Update hatch-gradle-version - Update to latest hexdoc - Bump hexdoc - Maybe fix testpypi index condition - Maybe fix testpypi index condition, again - Add mod_version plugin hook - Use new pluggy hooks - Make resource dirs modules - Fix resources path - Fix 0.2.x docgen support - Add 0.2.18-docs option - Bump hexdoc - Use new i18n stuff - Switch back to specified branches - Disable testpypi index and add workflow updates - Fix testpypi condition - Improve summary formatting - Use reusable workflow - Re-add workflow modifications - Add namespaced template imports - Switch to object-Object/hexdoc action - Exclude venv - Switch from cookiecutter to copier - Update hexdoc template from v0.0.1 to v0.1.0 - Fix export path and add branch pattern - Update template - Assorted hexdoc fixes - Update template - Fix zh_cn book build
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.
This PR creates a hexdoc plugin for Hexal using hexdoc-hexcasting-template.
It changes a lot of files, but most of them are in
doc- hexdoc no longer requires theHexCastingResourcesdirectory. I also changed some Patchouli-related files to fix validation errors (eg. broken links, incorrect Patchouli fields).You'll still need to go through the steps to set up GitHub Pages and PyPI - those are per-repo settings, not something that can be done in a PR. If you want, I can also help set up
https://hexal.hexxy.mediaas the custom Pages domain for this repo.One important thing to look at is the build_docs.yml file - this is what builds, deployes, and publishes the web book and PyPI package. Currently it's set up to publish a new release when a tag is pushed or a commit message starts with
[Release], but you'd probably want to change that based on however you usually do releases.It would also probably be a good idea to remove that file from the
mainbranch.(Also, sorry for the large commit count - I was using this branch while developing hexdoc to test some things, so it's a bit of a mess. I can squash it if you want.)done!