| Name | hexdoc-hexresearch JSON |
| Version |
1.0.1.1.0.dev0
JSON |
| download |
| home_page | |
| Summary | Python web book docgen and hexdoc plugin for Hex Research. |
| upload_time | 2024-01-19 18:49:31 |
| maintainer | |
| docs_url | None |
| author | Dashkal |
| 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-hexresearch
Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hex Research.
## 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=Dashkal/hexresearch
GITHUB_SHA=develop
GITHUB_PAGES_URL=https://dashkal.github.io/hexresearch
```
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-hexresearch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "hexdoc",
"author": "Dashkal",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f4/89/1b9093df868553f418a977f058fe74cc162bfd1d1be4d4d04c03650c3b81/hexdoc_hexresearch-1.0.1.1.0.dev0.tar.gz",
"platform": null,
"description": "# hexdoc-hexresearch\n\nPython web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hex Research.\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=Dashkal/hexresearch\nGITHUB_SHA=develop\nGITHUB_PAGES_URL=https://dashkal.github.io/hexresearch\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 Hex Research.",
"version": "1.0.1.1.0.dev0",
"project_urls": {
"Homepage": "https://dashkal.github.io/hexresearch",
"Source": "https://github.com/Dashkal/hexresearch"
},
"split_keywords": [
"hexdoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35f9f21a569f58cce6e51bb2ee562782c97827f5dcfb37509b211e962975c693",
"md5": "a733ba0b7406e61b43f7bcb80bbbcb4d",
"sha256": "d1ead510c5350c6be3e2fb8973f205cbffdf6bb7b86af5f8770d8d696b9c2bfd"
},
"downloads": -1,
"filename": "hexdoc_hexresearch-1.0.1.1.0.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a733ba0b7406e61b43f7bcb80bbbcb4d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 20306,
"upload_time": "2024-01-19T18:49:30",
"upload_time_iso_8601": "2024-01-19T18:49:30.306643Z",
"url": "https://files.pythonhosted.org/packages/35/f9/f21a569f58cce6e51bb2ee562782c97827f5dcfb37509b211e962975c693/hexdoc_hexresearch-1.0.1.1.0.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f4891b9093df868553f418a977f058fe74cc162bfd1d1be4d4d04c03650c3b81",
"md5": "8e3c30569d011c226ec7830a51bae659",
"sha256": "a7134e8540551865fd530fd953bddc52d2f17dc4fb05955d45424abd354c8cc0"
},
"downloads": -1,
"filename": "hexdoc_hexresearch-1.0.1.1.0.dev0.tar.gz",
"has_sig": false,
"md5_digest": "8e3c30569d011c226ec7830a51bae659",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13814,
"upload_time": "2024-01-19T18:49:31",
"upload_time_iso_8601": "2024-01-19T18:49:31.845235Z",
"url": "https://files.pythonhosted.org/packages/f4/89/1b9093df868553f418a977f058fe74cc162bfd1d1be4d4d04c03650c3b81/hexdoc_hexresearch-1.0.1.1.0.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-19 18:49:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Dashkal",
"github_project": "hexresearch",
"github_not_found": true,
"lcname": "hexdoc-hexresearch"
}
