This release is a pre-release and may not be stable for production use.
hexdoc-hexbound
Python web book docgen and hexdoc plugin for Hexbound.
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
Setup
Install Python 3.11.
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] --find-links ./doc/libs
Usage
For local testing, create a file called .env in the repo root following this template:
GITHUB_REPOSITORY=object-Object/hexbound
GITHUB_SHA=1.19
GITHUB_PAGES_URL=https://hexbound.hexxy.media/
Useful commands:
# show help
hexdoc -h
# render and serve the web book in watch mode
nodemon --config doc/nodemon.json
# render and serve the web book
hexdoc serve
# export, render, and merge the web book
hexdoc export
hexdoc render
hexdoc merge
# start the Python interpreter with some extra local variables
hexdoc repl
Metadata
Release files for hexdoc-hexbound 0.1.4.1.19.2.1.0.dev2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz | 38.2 kB | Without provenance | Details for hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2-py3-none-any.whl | Python 3 | none | any | Details for hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2-py3-none-any.whl |
Total release size: 93.0 kB
Release files / hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz
| Download URL | hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz |
|---|---|
| Size | 38.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0ae0dd7be39b3ef786ba684c4162797bc04e9ee0c9b6b8ec69a12ef693f79f5f
|
|
BLAKE2b-256 checksum How to use checksums |
92e682a503b665df2a0de2e678907c1ea71fbc13e81e18a78dd78e6986da1226
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
Release files / hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2-py3-none-any.whl
| Download URL | hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2-py3-none-any.whl |
|---|---|
| Size | 54.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3f4a859c431867ed4f479c6cc86c114b21355f08c81c57577eae286dfdd11c73
|
|
BLAKE2b-256 checksum How to use checksums |
bdb6310a101498524fd85ebef0aec4806b347e96fcd626a42baeebfadbfcf05d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
Security for hexdoc-hexbound 0.1.4.1.19.2.1.0.dev2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.