Python web book docgen and hexdoc plugin for Mediaworks.
Project description
hexdoc-mediaworks
Python web book docgen and hexdoc plugin for Mediaworks.
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 and Node 18 (20+ is not currently supported).
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=artynova/mediaworks
GITHUB_SHA=main
GITHUB_PAGES_URL=https://artynova.github.io/mediaworks/
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
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_mediaworks-1.0.6.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e246e079c247154061ea94168318ac073cf2a18194403232a7e8916298299ab |
|
MD5 | 35cd71de9c22815bd4ed4ad22eb3c705 |
|
BLAKE2b-256 | 081f32a3e1dcb1f8675b54afa5d92e1b849af1806c94b47f2323a2abf6030aec |
Close
Hashes for hexdoc_mediaworks-1.0.6.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc7bd13d8f50ffbfc72bd84dca95f03f4f088ce2ec045028803bd887129af670 |
|
MD5 | 0a86d1c1209c86d2f799d6e4c7084909 |
|
BLAKE2b-256 | b7e1e4c601527fe3091e45fcc221d1a95a862bfd898a7f15e8137e756d68dff7 |