| Name | hexdoc-hexical JSON |
| Version |
1.3.2.1.0.dev0
JSON |
| download |
| home_page | None |
| Summary | Python web book docgen and hexdoc plugin for Hexical. |
| upload_time | 2024-08-21 15:09:07 |
| maintainer | None |
| docs_url | None |
| author | miyucomics |
| 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-hexical
Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hexical.
## 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=miyucomics/hexical
GITHUB_SHA=main
GITHUB_PAGES_URL=https://miyucomics.github.io/hexical/
```
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-hexical",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "hexdoc",
"author": "miyucomics",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ca/62/6fe4844a9f13209de843da22905dd874179080ec1d515b761581418184a1/hexdoc_hexical-1.3.2.1.0.dev0.tar.gz",
"platform": null,
"description": "# hexdoc-hexical\n\nPython web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hexical.\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=miyucomics/hexical\nGITHUB_SHA=main\nGITHUB_PAGES_URL=https://miyucomics.github.io/hexical/\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 Hexical.",
"version": "1.3.2.1.0.dev0",
"project_urls": {
"Homepage": "https://miyucomics.github.io/hexical/",
"Source": "https://github.com/miyucomics/hexical"
},
"split_keywords": [
"hexdoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b94eb3175b86149dc4be023ef18988a6bcd129106cc7950108995a64f7f6f01",
"md5": "722fb8c8b8e8fcd3adb7904abf86ea98",
"sha256": "069799a1cc608d7f25c9eb9197075ed6f3b851c9ecf0ddb03128e91db378555b"
},
"downloads": -1,
"filename": "hexdoc_hexical-1.3.2.1.0.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "722fb8c8b8e8fcd3adb7904abf86ea98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 147880,
"upload_time": "2024-08-21T15:09:06",
"upload_time_iso_8601": "2024-08-21T15:09:06.370010Z",
"url": "https://files.pythonhosted.org/packages/0b/94/eb3175b86149dc4be023ef18988a6bcd129106cc7950108995a64f7f6f01/hexdoc_hexical-1.3.2.1.0.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca626fe4844a9f13209de843da22905dd874179080ec1d515b761581418184a1",
"md5": "531f305ca52ceb31d5f8239be2c09cb9",
"sha256": "fc365ffa71b52f3c2a96ca376e922758e5ec9a14062fcc81c215c96a775b880d"
},
"downloads": -1,
"filename": "hexdoc_hexical-1.3.2.1.0.dev0.tar.gz",
"has_sig": false,
"md5_digest": "531f305ca52ceb31d5f8239be2c09cb9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 85856,
"upload_time": "2024-08-21T15:09:07",
"upload_time_iso_8601": "2024-08-21T15:09:07.603422Z",
"url": "https://files.pythonhosted.org/packages/ca/62/6fe4844a9f13209de843da22905dd874179080ec1d515b761581418184a1/hexdoc_hexical-1.3.2.1.0.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 15:09:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "miyucomics",
"github_project": "hexical",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hexdoc-hexical"
}
