Skip to content

Commit

Permalink
Fix documentation for rendering specific models
Browse files Browse the repository at this point in the history
  • Loading branch information
object-Object committed May 2, 2024
1 parent d3c872c commit 324188e
Showing 1 changed file with 5 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ For a complete example, see [examples/model_rendering](https://github.com/hexdoc
## Setup

1. In a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments), install the following Python packages:
* `hexdoc>=1!0.1.0a16`
* `hexdoc>=1!0.1.0a15`
* `hexdoc-minecraft~={GAME_VERSION}.0` (eg. `hexdoc-minecraft~=1.19.2.0`)
2. Create a [`hexdoc.toml` config file](../../configuration):

Expand Down Expand Up @@ -43,7 +43,10 @@ For a complete example, see [examples/model_rendering](https://github.com/hexdoc
# render all available models
hexdoc render-models --all

# render one or more specific models
# render a specific model
hexdoc render-model minecraft:block/stone

# render several specific models (since 1!0.1.0a16)
hexdoc render-models minecraft:block/anvil hexcasting:amethyst_sconce
```

Expand Down

0 comments on commit 324188e

Please sign in to comment.