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.7.1.0.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f6eebd083ebc5baf2f51897f9f2c056fb45c717a7e7a034c0546ddb26253f29 |
|
MD5 | 528b1a1ba3317d22305433854193b343 |
|
BLAKE2b-256 | 03056eae43f89cd7617a8e347067e0ed851021dbb3e5ebcfaf868bd546ec0b53 |
Close
Hashes for hexdoc_mediaworks-1.0.7.1.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35b5b460595da51dca83b6e13ac664d92af78b547e760b4c644c4c3d3d5c8180 |
|
MD5 | d6076026926b1046cb69b3747064e944 |
|
BLAKE2b-256 | c26e8524c49a26e9f3a8bbd703547283f92959b694b824da8a7c2d85796159e1 |