| Name | hexdoc-hexcasting JSON |
| Version |
0.10.3.1.0
JSON |
| download |
| home_page | None |
| Summary | Hex Casting web book. |
| upload_time | 2024-04-06 22:57:56 |
| maintainer | None |
| docs_url | None |
| author | object-Object, Alwinfy |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2024 object-Object, Alwinfy, gamma-delta Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
hexdoc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hexdoc-hexcasting
Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hex Casting.
## 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
```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=gamma-delta/HexMod
GITHUB_SHA=main
GITHUB_PAGES_URL=https://gamma-delta.github.io/HexMod
```
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-hexcasting",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "hexdoc",
"author": "object-Object, Alwinfy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6c/9a/bced9242837d2214194a20eb87c3274ab92083706ee549a3cd1f62aecab6/hexdoc_hexcasting-0.10.3.1.0.tar.gz",
"platform": null,
"description": "# hexdoc-hexcasting\n\nPython web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hex Casting.\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\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=gamma-delta/HexMod\nGITHUB_SHA=main\nGITHUB_PAGES_URL=https://gamma-delta.github.io/HexMod\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": "MIT License Copyright (c) 2024 object-Object, Alwinfy, gamma-delta Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Hex Casting web book.",
"version": "0.10.3.1.0",
"project_urls": {
"Homepage": "https://gamma-delta.github.io/HexMod/",
"Source": "https://github.com/gamma-delta/HexMod/"
},
"split_keywords": [
"hexdoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c5e82de258c7e3e2fb3de3d958f3efc3b902e915a68dfa7c7968e35c5bbda19b",
"md5": "5c32960ae634c2021d25f56a06b15445",
"sha256": "e3a4909a466c425b8f8265c5b3049f5845ea8b4133f8aa96256aebb124f6b6a5"
},
"downloads": -1,
"filename": "hexdoc_hexcasting-0.10.3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c32960ae634c2021d25f56a06b15445",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 1088785,
"upload_time": "2024-04-06T22:57:54",
"upload_time_iso_8601": "2024-04-06T22:57:54.216050Z",
"url": "https://files.pythonhosted.org/packages/c5/e8/2de258c7e3e2fb3de3d958f3efc3b902e915a68dfa7c7968e35c5bbda19b/hexdoc_hexcasting-0.10.3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6c9abced9242837d2214194a20eb87c3274ab92083706ee549a3cd1f62aecab6",
"md5": "036e30ffeaa19e5cb2f606f7ebfedfa2",
"sha256": "e1a623e626b9e82dd411d9ffd97631de203c034c4c0471f04a66defac2a421d1"
},
"downloads": -1,
"filename": "hexdoc_hexcasting-0.10.3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "036e30ffeaa19e5cb2f606f7ebfedfa2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 837723,
"upload_time": "2024-04-06T22:57:56",
"upload_time_iso_8601": "2024-04-06T22:57:56.290417Z",
"url": "https://files.pythonhosted.org/packages/6c/9a/bced9242837d2214194a20eb87c3274ab92083706ee549a3cd1f62aecab6/hexdoc_hexcasting-0.10.3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-06 22:57:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gamma-delta",
"github_project": "HexMod",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hexdoc-hexcasting"
}
