hexdoc


Namehexdoc JSON
Version 1!0.1.0a10 PyPI version JSON
download
home_page
SummaryPython web book docgen for Patchouli and Hex Casting.
upload_time2024-02-23 00:20:21
maintainer
docs_urlNone
authorobject-Object, Alwinfy
requires_python>=3.11
licenseMIT License Copyright (c) 2023 object-Object 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.
            <p align="center">
  <img alt="hexdoc logo" src="https://github.com/hexdoc-dev/hexdoc/raw/main/media/hexdoc.svg" height="200" />
  <br /><br />
  <a href="https://hexdoc.hexxy.media/"><img alt="Docs - hexdoc.hexxy.media" src="https://img.shields.io/badge/docs-hexdoc.hexxy.media-darkmagenta"></a>
  <a href="https://pypi.org/project/hexdoc/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/hexdoc"></a>
  <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/hexdoc">
  <a href="https://github.com/hexdoc-dev/hexdoc/actions/workflows/ci.yml"><img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/hexdoc-dev/hexdoc/ci.yml?logo=github&label=ci"></a>
  <a href="https://github.com/hexdoc-dev/hexdoc#badges"><img src="https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc" alt="hexdoc" style="max-width:100%;"></a>
</p>

# hexdoc

A [Jinja](https://jinja.palletsprojects.com/en/3.1.x/)-based documentation generator for [Patchouli](https://github.com/VazkiiMods/Patchouli) books.

This is the library that powers [Hex Casting](https://github.com/gamma-delta/HexMod)'s web book.

## IMPORTANT: Version incompatibilities

There are issues related to installing hexdoc with the following dependency versions:
* Python 3.12+ on Windows: https://github.com/aio-libs/multidict/issues/887
* Node.js 20+: https://github.com/stackgl/headless-gl/issues/268

hexdoc is known to work with Python 3.11 and Node.js 18.

## Plugins

See [hexdoc-hexcasting-template](https://github.com/hexdoc-dev/hexdoc-hexcasting-template) for instructions to set up a hexdoc plugin for a pre-existing Hex Casting addon.

## Contributing

### Setup

```sh
git submodule update --init

python3.11 -m venv venv

.\venv\Scripts\activate   # Windows
. venv/bin/activate.fish  # fish
source venv/bin/activate  # everything else

pip install -e .[dev]
pre-commit install
```

### Usage

For local testing, create a file called `.env` in the repo root following this template:
```sh
GITHUB_SHA=main
GITHUB_REPOSITORY=hexdoc-dev/hexdoc
GITHUB_PAGES_URL=https://hexdoc.hexxy.media
```

Useful commands:
```sh
# show help
hexdoc -h

# serve hexdoc resources locally
# this is useful if serving other books locally that depend on hexdoc resources
nodemon --exec "hexdoc serve --port 8001 --no-merge"

# render and serve the Hex Casting web book in watch mode
nodemon

# start the Python interpreter with some extra local variables
hexdoc repl

# run tests
pytest  # fast, skips Cookiecutter
nox  # slow, full test suite in an isolated venv
nox --no-install  # after the first Nox run, use this to skip reinstalling everything

# update test snapshots (only running sessions with the tag "test")
nox -t test -- --snapshot-update

# run hexdoc commands in an isolated environment to ensure it works on its own
nox -s hexdoc -- build
nox -s hexdoc -- repl

# set up a dummy book for local testing
nox -s dummy_setup
nox -s dummy_serve

nox -s dummy_hexdoc -- build

nox -s dummy_clean
```

## Badges

### Shields.io

<a href="https://github.com/hexdoc-dev/hexdoc"><img src="https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc" alt="hexdoc" style="max-width:100%;"></a>
<a href="https://github.com/hexdoc-dev/hexdoc"><img src="https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1" alt="powered by hexdoc" style="max-width:100%;"></a>

#### Markdown

```md
[![hexdoc](https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc)](https://github.com/hexdoc-dev/hexdoc)

[![powered by hexdoc](https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1)](https://github.com/hexdoc-dev/hexdoc)
```

#### HTML

```html
<a href="https://github.com/hexdoc-dev/hexdoc"><img src="https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc" alt="hexdoc" style="max-width:100%;"></a>

<a href="https://github.com/hexdoc-dev/hexdoc"><img src="https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1" alt="powered by hexdoc" style="max-width:100%;"></a>
```

#### reStructuredText

```rst
.. image:: https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc
    :target: https://github.com/hexdoc-dev/hexdoc
    :alt: hexdoc

.. image:: https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1
    :target: https://github.com/hexdoc-dev/hexdoc
    :alt: powered by hexdoc
```

### Devin's Badges

<a target="_blank" href="https://hexcasting.hexxy.media"><img src="https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/hexdoc-badgecozy.svg?raw=true" alt="A badge for hexdoc in the style of Devins Badges" width=225></a>
<a target="_blank" href="https://addons.hexxy.media" height=75><img src="https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/addon-badge-cozy.svg?raw=true" alt="A badge for addons.hexxy.media in the style of Devins Badges" width=200></a>

Thanks to [Sam](https://github.com/SamsTheNerd) for making these!

#### HTML

```html
<a target="_blank" href="INSERT_YOUR_BOOK_LINK_HERE"><img src="https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/hexdoc-badgecozy.svg?raw=true" alt="A badge for hexdoc in the style of Devins Badges" width=225></a>

<a target="_blank" href="https://addons.hexxy.media" height=75><img src="https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/addon-badge-cozy.svg?raw=true" alt="A badge for addons.hexxy.media in the style of Devins Badges" width=200></a>
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "hexdoc",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "",
    "keywords": "hexdoc",
    "author": "object-Object, Alwinfy",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/9b/6d/e62be057290b1972afa131e257d8c5730b6a8754b3f140f79714d10b3489/hexdoc-1!0.1.0a10.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img alt=\"hexdoc logo\" src=\"https://github.com/hexdoc-dev/hexdoc/raw/main/media/hexdoc.svg\" height=\"200\" />\n  <br /><br />\n  <a href=\"https://hexdoc.hexxy.media/\"><img alt=\"Docs - hexdoc.hexxy.media\" src=\"https://img.shields.io/badge/docs-hexdoc.hexxy.media-darkmagenta\"></a>\n  <a href=\"https://pypi.org/project/hexdoc/\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/hexdoc\"></a>\n  <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/hexdoc\">\n  <a href=\"https://github.com/hexdoc-dev/hexdoc/actions/workflows/ci.yml\"><img alt=\"GitHub Workflow Status (with event)\" src=\"https://img.shields.io/github/actions/workflow/status/hexdoc-dev/hexdoc/ci.yml?logo=github&label=ci\"></a>\n  <a href=\"https://github.com/hexdoc-dev/hexdoc#badges\"><img src=\"https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc\" alt=\"hexdoc\" style=\"max-width:100%;\"></a>\n</p>\n\n# hexdoc\n\nA [Jinja](https://jinja.palletsprojects.com/en/3.1.x/)-based documentation generator for [Patchouli](https://github.com/VazkiiMods/Patchouli) books.\n\nThis is the library that powers [Hex Casting](https://github.com/gamma-delta/HexMod)'s web book.\n\n## IMPORTANT: Version incompatibilities\n\nThere are issues related to installing hexdoc with the following dependency versions:\n* Python 3.12+ on Windows: https://github.com/aio-libs/multidict/issues/887\n* Node.js 20+: https://github.com/stackgl/headless-gl/issues/268\n\nhexdoc is known to work with Python 3.11 and Node.js 18.\n\n## Plugins\n\nSee [hexdoc-hexcasting-template](https://github.com/hexdoc-dev/hexdoc-hexcasting-template) for instructions to set up a hexdoc plugin for a pre-existing Hex Casting addon.\n\n## Contributing\n\n### Setup\n\n```sh\ngit submodule update --init\n\npython3.11 -m venv venv\n\n.\\venv\\Scripts\\activate   # Windows\n. venv/bin/activate.fish  # fish\nsource venv/bin/activate  # everything else\n\npip install -e .[dev]\npre-commit install\n```\n\n### Usage\n\nFor local testing, create a file called `.env` in the repo root following this template:\n```sh\nGITHUB_SHA=main\nGITHUB_REPOSITORY=hexdoc-dev/hexdoc\nGITHUB_PAGES_URL=https://hexdoc.hexxy.media\n```\n\nUseful commands:\n```sh\n# show help\nhexdoc -h\n\n# serve hexdoc resources locally\n# this is useful if serving other books locally that depend on hexdoc resources\nnodemon --exec \"hexdoc serve --port 8001 --no-merge\"\n\n# render and serve the Hex Casting web book in watch mode\nnodemon\n\n# start the Python interpreter with some extra local variables\nhexdoc repl\n\n# run tests\npytest  # fast, skips Cookiecutter\nnox  # slow, full test suite in an isolated venv\nnox --no-install  # after the first Nox run, use this to skip reinstalling everything\n\n# update test snapshots (only running sessions with the tag \"test\")\nnox -t test -- --snapshot-update\n\n# run hexdoc commands in an isolated environment to ensure it works on its own\nnox -s hexdoc -- build\nnox -s hexdoc -- repl\n\n# set up a dummy book for local testing\nnox -s dummy_setup\nnox -s dummy_serve\n\nnox -s dummy_hexdoc -- build\n\nnox -s dummy_clean\n```\n\n## Badges\n\n### Shields.io\n\n<a href=\"https://github.com/hexdoc-dev/hexdoc\"><img src=\"https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc\" alt=\"hexdoc\" style=\"max-width:100%;\"></a>\n<a href=\"https://github.com/hexdoc-dev/hexdoc\"><img src=\"https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1\" alt=\"powered by hexdoc\" style=\"max-width:100%;\"></a>\n\n#### Markdown\n\n```md\n[![hexdoc](https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc)](https://github.com/hexdoc-dev/hexdoc)\n\n[![powered by hexdoc](https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1)](https://github.com/hexdoc-dev/hexdoc)\n```\n\n#### HTML\n\n```html\n<a href=\"https://github.com/hexdoc-dev/hexdoc\"><img src=\"https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc\" alt=\"hexdoc\" style=\"max-width:100%;\"></a>\n\n<a href=\"https://github.com/hexdoc-dev/hexdoc\"><img src=\"https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1\" alt=\"powered by hexdoc\" style=\"max-width:100%;\"></a>\n```\n\n#### reStructuredText\n\n```rst\n.. image:: https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc\n    :target: https://github.com/hexdoc-dev/hexdoc\n    :alt: hexdoc\n\n.. image:: https://img.shields.io/endpoint?url=https://hexxy.media/api/v0/badge/hexdoc?label=1\n    :target: https://github.com/hexdoc-dev/hexdoc\n    :alt: powered by hexdoc\n```\n\n### Devin's Badges\n\n<a target=\"_blank\" href=\"https://hexcasting.hexxy.media\"><img src=\"https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/hexdoc-badgecozy.svg?raw=true\" alt=\"A badge for hexdoc in the style of Devins Badges\" width=225></a>\n<a target=\"_blank\" href=\"https://addons.hexxy.media\" height=75><img src=\"https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/addon-badge-cozy.svg?raw=true\" alt=\"A badge for addons.hexxy.media in the style of Devins Badges\" width=200></a>\n\nThanks to [Sam](https://github.com/SamsTheNerd) for making these!\n\n#### HTML\n\n```html\n<a target=\"_blank\" href=\"INSERT_YOUR_BOOK_LINK_HERE\"><img src=\"https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/hexdoc-badgecozy.svg?raw=true\" alt=\"A badge for hexdoc in the style of Devins Badges\" width=225></a>\n\n<a target=\"_blank\" href=\"https://addons.hexxy.media\" height=75><img src=\"https://github.com/SamsTheNerd/HexGloop/blob/73ea39b3becd/externalassets/addon-badge-cozy.svg?raw=true\" alt=\"A badge for addons.hexxy.media in the style of Devins Badges\" width=200></a>\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 object-Object  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": "Python web book docgen for Patchouli and Hex Casting.",
    "version": "1!0.1.0a10",
    "project_urls": {
        "Documentation": "https://hexdoc.hexxy.media",
        "Homepage": "https://book.hexxy.media",
        "Source": "https://github.com/hexdoc-dev/hexdoc"
    },
    "split_keywords": [
        "hexdoc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "935de7b96b0153e218631b37bafde8bda0723f80384e105d3913f2711142d10d",
                "md5": "cd2ccd75a99545ea1de598532b136bc1",
                "sha256": "410f36a9eeeb45811cbf59760fc4d6a51ad0794e525426f2564d7c1c73d26b80"
            },
            "downloads": -1,
            "filename": "hexdoc-1!0.1.0a10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cd2ccd75a99545ea1de598532b136bc1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 189246,
            "upload_time": "2024-02-23T00:20:18",
            "upload_time_iso_8601": "2024-02-23T00:20:18.290610Z",
            "url": "https://files.pythonhosted.org/packages/93/5d/e7b96b0153e218631b37bafde8bda0723f80384e105d3913f2711142d10d/hexdoc-1!0.1.0a10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9b6de62be057290b1972afa131e257d8c5730b6a8754b3f140f79714d10b3489",
                "md5": "d0aa4ec9ef8ad2def0f953d90916db51",
                "sha256": "b4b38a42cd9b47537be4449c07d848eab1cf63ae36d07594cec313e6d3b3f763"
            },
            "downloads": -1,
            "filename": "hexdoc-1!0.1.0a10.tar.gz",
            "has_sig": false,
            "md5_digest": "d0aa4ec9ef8ad2def0f953d90916db51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 129428,
            "upload_time": "2024-02-23T00:20:21",
            "upload_time_iso_8601": "2024-02-23T00:20:21.024381Z",
            "url": "https://files.pythonhosted.org/packages/9b/6d/e62be057290b1972afa131e257d8c5730b6a8754b3f140f79714d10b3489/hexdoc-1!0.1.0a10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-23 00:20:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hexdoc-dev",
    "github_project": "hexdoc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hexdoc"
}
        
Elapsed time: 0.24464s