| Name | hexdoc-hexbound JSON |
| Version |
0.1.4.1.19.2.1.0.dev2
JSON |
| download |
| home_page | None |
| Summary | Python web book docgen and hexdoc plugin for Hexbound. |
| upload_time | 2024-08-31 18:38:32 |
| maintainer | object-Object |
| docs_url | None |
| author | Cypher121 |
| 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-hexbound
Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hexbound.
## 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.
```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] --find-links ./doc/libs
```
## Usage
For local testing, create a file called `.env` in the repo root following this template:
```sh
GITHUB_REPOSITORY=object-Object/hexbound
GITHUB_SHA=1.19
GITHUB_PAGES_URL=https://hexbound.hexxy.media/
```
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-hexbound",
"maintainer": "object-Object",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "hexdoc",
"author": "Cypher121",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/92/e6/82a503b665df2a0de2e678907c1ea71fbc13e81e18a78dd78e6986da1226/hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz",
"platform": null,
"description": "# hexdoc-hexbound\n\nPython web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hexbound.\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.\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] --find-links ./doc/libs\n```\n\n## Usage\n\nFor local testing, create a file called `.env` in the repo root following this template:\n```sh\nGITHUB_REPOSITORY=object-Object/hexbound\nGITHUB_SHA=1.19\nGITHUB_PAGES_URL=https://hexbound.hexxy.media/\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 Hexbound.",
"version": "0.1.4.1.19.2.1.0.dev2",
"project_urls": {
"Homepage": "https://hexbound.hexxy.media",
"Source": "https://github.com/object-Object/hexbound"
},
"split_keywords": [
"hexdoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bdb6310a101498524fd85ebef0aec4806b347e96fcd626a42baeebfadbfcf05d",
"md5": "0d7d02b1e556b2ad0bc8cf85778f4617",
"sha256": "3f4a859c431867ed4f479c6cc86c114b21355f08c81c57577eae286dfdd11c73"
},
"downloads": -1,
"filename": "hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0d7d02b1e556b2ad0bc8cf85778f4617",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 54831,
"upload_time": "2024-08-31T18:38:30",
"upload_time_iso_8601": "2024-08-31T18:38:30.874014Z",
"url": "https://files.pythonhosted.org/packages/bd/b6/310a101498524fd85ebef0aec4806b347e96fcd626a42baeebfadbfcf05d/hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92e682a503b665df2a0de2e678907c1ea71fbc13e81e18a78dd78e6986da1226",
"md5": "ef859343ebf384d24a1f9e1472623e6f",
"sha256": "0ae0dd7be39b3ef786ba684c4162797bc04e9ee0c9b6b8ec69a12ef693f79f5f"
},
"downloads": -1,
"filename": "hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz",
"has_sig": false,
"md5_digest": "ef859343ebf384d24a1f9e1472623e6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 38185,
"upload_time": "2024-08-31T18:38:32",
"upload_time_iso_8601": "2024-08-31T18:38:32.679439Z",
"url": "https://files.pythonhosted.org/packages/92/e6/82a503b665df2a0de2e678907c1ea71fbc13e81e18a78dd78e6986da1226/hexdoc_hexbound-0.1.4.1.19.2.1.0.dev2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 18:38:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "object-Object",
"github_project": "hexbound",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hexdoc-hexbound"
}
