| Name | hexdoc-hexkeys JSON |
| Version |
0.1.3.1.0.dev0
JSON |
| download |
| home_page | None |
| Summary | Python web book docgen and hexdoc plugin for Hex Keys. |
| upload_time | 2024-07-18 03:35:47 |
| maintainer | None |
| docs_url | None |
| author | MoonlitJolteon |
| requires_python | >=3.11 |
| license | None |
| keywords |
hexdoc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hexdoc-hexkeys
Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hex Keys.
## Version scheme
We use [hatch-gradle-version](https://pypi.org/project/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).
```sh
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:
```sh
GITHUB_REPOSITORY=MoonlitJolteon/hex-keys-addon
GITHUB_SHA=main
GITHUB_PAGES_URL=https://moonlitjolteon.github.io/hex-keys-addon
```
Useful commands:
```sh
# 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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "hexdoc-hexkeys",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "hexdoc",
"author": "MoonlitJolteon",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7b/08/2901f04bda0087ac33bee4cc119138725d5e24885dd67edf23851db20f61/hexdoc_hexkeys-0.1.3.1.0.dev0.tar.gz",
"platform": null,
"description": "# hexdoc-hexkeys\n\nPython web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hex Keys.\n\n## Version scheme\n\nWe use [hatch-gradle-version](https://pypi.org/project/hatch-gradle-version) to generate the version number based on whichever mod version the docgen was built with.\n\nThe version is in this format: `mod-version.python-version.mod-pre.python-dev.python-post`\n\nFor example:\n* Mod version: `0.11.1-7`\n* Python package version: `1.0.dev0`\n* Full version: `0.11.1.1.0rc7.dev0`\n\n## Setup\n\nInstall Python 3.11 and Node 18 (20+ is **not** currently supported).\n\n```sh\npython3.11 -m venv venv\n\n.\\venv\\Scripts\\activate # Windows\n. venv/bin/activate.fish # fish\nsource venv/bin/activate # everything else\n\n# run from the repo root, not doc/\npip install -e .[dev]\n```\n\n## Usage\n\nFor local testing, create a file called `.env` in the repo root following this template:\n```sh\nGITHUB_REPOSITORY=MoonlitJolteon/hex-keys-addon\nGITHUB_SHA=main\nGITHUB_PAGES_URL=https://moonlitjolteon.github.io/hex-keys-addon\n```\n\nUseful commands:\n```sh\n# show help\nhexdoc -h\n\n# render and serve the web book in watch mode\nnodemon --config doc/nodemon.json\n\n# render and serve the web book\nhexdoc serve\n\n# export, render, and merge the web book\nhexdoc export\nhexdoc render\nhexdoc merge\n\n# start the Python interpreter with some extra local variables\nhexdoc repl\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Python web book docgen and hexdoc plugin for Hex Keys.",
"version": "0.1.3.1.0.dev0",
"project_urls": {
"Homepage": "https://moonlitjolteon.github.io/hex-keys-addon",
"Source": "https://github.com/MoonlitJolteon/hex-keys-addon"
},
"split_keywords": [
"hexdoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d13586c8dc72c215647f14d04244afe7aab344457dddc0e1ec44cc3a92cf960c",
"md5": "a15cd7173cba9731326c6c3540ae8c3b",
"sha256": "5ce1088a76a6dc5fcea607481fea9ac97afc54bb4c226e9009bdbaef52f1c7c7"
},
"downloads": -1,
"filename": "hexdoc_hexkeys-0.1.3.1.0.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a15cd7173cba9731326c6c3540ae8c3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 15901,
"upload_time": "2024-07-18T03:35:46",
"upload_time_iso_8601": "2024-07-18T03:35:46.131423Z",
"url": "https://files.pythonhosted.org/packages/d1/35/86c8dc72c215647f14d04244afe7aab344457dddc0e1ec44cc3a92cf960c/hexdoc_hexkeys-0.1.3.1.0.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7b082901f04bda0087ac33bee4cc119138725d5e24885dd67edf23851db20f61",
"md5": "6bee9b8f90df3d20556e4d681a060a32",
"sha256": "38106e0f577ad82e88bc171de37d507e0fc86399ffaef29ac8057fff5a7cca8b"
},
"downloads": -1,
"filename": "hexdoc_hexkeys-0.1.3.1.0.dev0.tar.gz",
"has_sig": false,
"md5_digest": "6bee9b8f90df3d20556e4d681a060a32",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 11501,
"upload_time": "2024-07-18T03:35:47",
"upload_time_iso_8601": "2024-07-18T03:35:47.376722Z",
"url": "https://files.pythonhosted.org/packages/7b/08/2901f04bda0087ac33bee4cc119138725d5e24885dd67edf23851db20f61/hexdoc_hexkeys-0.1.3.1.0.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-18 03:35:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MoonlitJolteon",
"github_project": "hex-keys-addon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hexdoc-hexkeys"
}
