Hex Casting web book.
Project description
hexdoc
This is the Python docgen for Hex Casting.
Version scheme
We use hatch-gradle-version to generate the version number based on whichever mod version the docgen was built with.
The version is in this format: mod-version.python-version.mod-pre.python-dev.python-post
For example:
- Mod version:
0.11.1-7
- Python package version:
1.0.dev0
- Full version:
0.11.1.1.0rc7.dev0
Creating a plugin / addon
WIP.
- Run these commands, then follow the prompts:
pip3 install cruft cruft create gh:object-Object/HexMod --directory doc
--directory doc
tells Cookiecutter to look for a template in thedoc
directory of HexMod, and cannot be omitted.- If you run this from within an existing mod repo, add the flag
-f
, and leave theoutput_directory
option blank when prompted by Cookiecutter.- Note: this currently overwrites any conflicting files, including your .gitignore, so you may need to use your Git history to re-add anything not covered by the new file.
- Fill in the TODOs in
doc/hexdoc.toml
(mostly paths to files/folders in your mod so hexdoc can find the data it needs). - Try running the docgen locally by following the instructions in
doc/README.md
. - If it doesn't already exist, create an empty
gh-pages
branch and push it. - On GitHub, under
Settings > Pages
, set the source toDeploy from a branch
, the branch togh-pages
, and the folder todocs/
. - Commit and push the docgen, and see if the CI works.
- On GitHub, under
Settings > Environments
, create two new environments calledpypi
andtestpypi
. - Follow these instructions for PyPI and TestPyPI: https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/
- TestPyPI is a duplicate of PyPI which can be used for testing package publishing without affecting the real index. The CI workflow includes a manual execution option to publish to TestPyPI.
- If you like to live dangerously, this step is optional - you can remove the
publish-testpypi
job and theTestPyPI
release choice from your workflow without impacting the rest of the CI.
Updating to the latest Cookiecutter template
Run this command: cruft update
See also: https://cruft.github.io/cruft/#updating-a-project
Setup
python3.11 -m venv venv
.\venv\Scripts\activate # Windows
. venv/bin/activate.fish # fish
source venv/bin/activate # everything else
# run from the repo root, not doc/
pip install -e .[dev]
Usage
For local testing, create a file called .env
in the repo root following this template:
GITHUB_REPOSITORY=gamma-delta/HexMod
GITHUB_SHA=main
GITHUB_PAGES_URL=https://gamma-delta.github.io/HexMod
Then run these commands to generate the book:
# run from the repo root, not doc/
hexdoc render
hexdoc merge
Or, run this command to render the book and start a local web server:
hexdoc serve --lang en_us
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for hexdoc_hexcasting-0.9.6.1.0.dev20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2369d0dbbe294e02883502e441cec27b2ff56db380b1b3e289b02aaf0ec10ddd |
|
MD5 | eb1a633ca651ae9be56b9caad6a4cdf4 |
|
BLAKE2b-256 | 689caef47102d3ac9ff710cfd44adcc0175a765a9cfafbbf995e9262711c4477 |
Close
Hashes for hexdoc_hexcasting-0.9.6.1.0.dev20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf529ddc73786eaed1b56ef654ddba626ea69b4d7b3eae0545b9b7d0fb2fbdcd |
|
MD5 | 29cba444aef3b06656d38b32551d0897 |
|
BLAKE2b-256 | 8123a3f718fdd78d50875883eb3fac65610062b4d8c5e17ac91eec8508e2e00b |