| Name | hexdoc-hexdim JSON |
| Version |
1.2.1.1.20.0
JSON |
| download |
| home_page | |
| Summary | Python web book docgen and hexdoc plugin for Hexxy Dimensions. |
| upload_time | 2024-01-18 22:10:35 |
| maintainer | |
| docs_url | None |
| author | walksanatora |
| requires_python | >=3.11 |
| license | |
| keywords |
hexdoc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# hexdoc-hexdim
Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hexxy Dimensions.
## 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=walksanatora/hexxy-dimensions
GITHUB_SHA=main
GITHUB_PAGES_URL=https://walksanatora.github.io/hexxy-dimensions/
```
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": "",
"name": "hexdoc-hexdim",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "hexdoc",
"author": "walksanatora",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f3/73/8e92562190b4c0b4c32038a0dcfa9e83c4b11a4a6cf0f79855e7ff0775c1/hexdoc_hexdim-1.2.1.1.20.0.tar.gz",
"platform": null,
"description": "# hexdoc-hexdim\n\nPython web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hexxy Dimensions.\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=walksanatora/hexxy-dimensions\nGITHUB_SHA=main\nGITHUB_PAGES_URL=https://walksanatora.github.io/hexxy-dimensions/\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": "",
"summary": "Python web book docgen and hexdoc plugin for Hexxy Dimensions.",
"version": "1.2.1.1.20.0",
"project_urls": {
"Homepage": "https://walksanatora.github.io/hexxy-dimensions/",
"Source": "https://github.com/walksanatora/hexxy-dimensions"
},
"split_keywords": [
"hexdoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "502a26dc1bf81b5d6957817eacabb13fe225420e57eb1919a957fd51ec5875ca",
"md5": "ced6937ab24f172971b57944dad16b85",
"sha256": "c6fdf8e335b573e75b6598d20536efe771be7d4c75e2ab44f3656184de7c6a5e"
},
"downloads": -1,
"filename": "hexdoc_hexdim-1.2.1.1.20.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ced6937ab24f172971b57944dad16b85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 15844,
"upload_time": "2024-01-18T22:10:34",
"upload_time_iso_8601": "2024-01-18T22:10:34.063706Z",
"url": "https://files.pythonhosted.org/packages/50/2a/26dc1bf81b5d6957817eacabb13fe225420e57eb1919a957fd51ec5875ca/hexdoc_hexdim-1.2.1.1.20.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f3738e92562190b4c0b4c32038a0dcfa9e83c4b11a4a6cf0f79855e7ff0775c1",
"md5": "36c79227479a9b672db4f06588d0545c",
"sha256": "68795a8aec5e22aa2b2d1f32c2b2e0d08484432e378e552aa80a69656360344d"
},
"downloads": -1,
"filename": "hexdoc_hexdim-1.2.1.1.20.0.tar.gz",
"has_sig": false,
"md5_digest": "36c79227479a9b672db4f06588d0545c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13451,
"upload_time": "2024-01-18T22:10:35",
"upload_time_iso_8601": "2024-01-18T22:10:35.581778Z",
"url": "https://files.pythonhosted.org/packages/f3/73/8e92562190b4c0b4c32038a0dcfa9e83c4b11a4a6cf0f79855e7ff0775c1/hexdoc_hexdim-1.2.1.1.20.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 22:10:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "walksanatora",
"github_project": "hexxy-dimensions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hexdoc-hexdim"
}
