hexdoc-hexcellular


Namehexdoc-hexcellular JSON
Version 1.1.0.1.0.0 PyPI version JSON
download
home_pageNone
SummaryPython web book docgen and hexdoc plugin for Hexcellular.
upload_time2025-07-18 02:04:20
maintainerNone
docs_urlNone
authormiyucomics
requires_python>=3.11
licenseNone
keywords hexdoc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # hexdoc-hexcellular

Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hexcellular.

## 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/hexcellular
GITHUB_SHA=main
GITHUB_PAGES_URL=https://miyucomics.github.io/hexcellular/
```

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-hexcellular",
    "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/45/10/7159c810ff25cdb530c5e406825f1452b18bf2eb34d58390b5509f9c37e9/hexdoc_hexcellular-1.1.0.1.0.0.tar.gz",
    "platform": null,
    "description": "# hexdoc-hexcellular\n\nPython web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for Hexcellular.\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/hexcellular\nGITHUB_SHA=main\nGITHUB_PAGES_URL=https://miyucomics.github.io/hexcellular/\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 Hexcellular.",
    "version": "1.1.0.1.0.0",
    "project_urls": {
        "Homepage": "https://miyucomics.github.io/hexcellular/",
        "Source": "https://github.com/miyucomics/hexcellular"
    },
    "split_keywords": [
        "hexdoc"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8ecfdae8aa5f27c921d136ea754a547a7eb1d569d679d512b5f1e84b113c4049",
                "md5": "43bfd0cc0a92f52061c1eab45030c410",
                "sha256": "8714b959cc56b88c1e1ea673e91149cd638b1d30f452f42084576acf510f875d"
            },
            "downloads": -1,
            "filename": "hexdoc_hexcellular-1.1.0.1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "43bfd0cc0a92f52061c1eab45030c410",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 11753,
            "upload_time": "2025-07-18T02:04:19",
            "upload_time_iso_8601": "2025-07-18T02:04:19.377531Z",
            "url": "https://files.pythonhosted.org/packages/8e/cf/dae8aa5f27c921d136ea754a547a7eb1d569d679d512b5f1e84b113c4049/hexdoc_hexcellular-1.1.0.1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "45107159c810ff25cdb530c5e406825f1452b18bf2eb34d58390b5509f9c37e9",
                "md5": "24aceced694d2d4465981dc781cdd4ea",
                "sha256": "7d673d161b0e79d24ba61e0488b08a1d0eeb58390c383b233f80612d982579f0"
            },
            "downloads": -1,
            "filename": "hexdoc_hexcellular-1.1.0.1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "24aceced694d2d4465981dc781cdd4ea",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 8927,
            "upload_time": "2025-07-18T02:04:20",
            "upload_time_iso_8601": "2025-07-18T02:04:20.469291Z",
            "url": "https://files.pythonhosted.org/packages/45/10/7159c810ff25cdb530c5e406825f1452b18bf2eb34d58390b5509f9c37e9/hexdoc_hexcellular-1.1.0.1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-18 02:04:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "miyucomics",
    "github_project": "hexcellular",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hexdoc-hexcellular"
}
        
Elapsed time: 0.46243s