# Sphinx Minecraft
Add different Minecraft-oriented components to Sphinx.
## Installation
```bash
pip install sphinx-minecraft
```
Add the extension to your Sphinx `conf.py`:
```python
extensions = [
'sphinx_minecraft'
]
```
## Available components
### Tree views
These components are based on [sphinx-treeview](https://github.com/Altearn/Sphinx-Tree-View).
#### Minecraft directory tree
**Usage:**
```rst
:::{treeview}
- {mcdir}`folder` folder
- {mcdir}`mcfunction` function.mcfunction
- {mcdir}`mcmeta` pack.mcmeta
- {mcdir}`nbt` structure.nbt
- {mcdir}`folder` folder2
- {mcdir}`file` file.txt
- {mcdir}`audio` sound.ogg
- {mcdir}`image` texture.png
- {mcdir}`json` advancement.json
- {mcdir}`yml` config.yml
:::
```
**Result:**
#### NBT tree
**Usage:**
```rst
:::{treeview}
- {nbt}`compound` A compound tag
- {nbt}`bool` A boolean tag
- {nbt}`byte` A byte tag
- {nbt}`short` A short tag
- {nbt}`int` An integer tag
- {nbt}`long` A long tag
- {nbt}`float` A float tag
- {nbt}`double` A double tag
- {nbt}`string` A string tag
- {nbt}`list` A list tag
- {nbt}`number` A number tag
- {nbt}`any` A tag to represent any type
- {nbt}`compound` A compound tag
- {nbt}`long-array` A long array tag
- {nbt}`byte-array` A byte array tag
- {nbt}`int-array` An integer array tag
:::
```
**Result:**
# License
This project is licensed under the MPL-2.0 License. See the [LICENSE](LICENSE) file for details.
File and folder icons came from [pictogrammers](https://pictogrammers.com/library/mdi/) and are under [Apache-2.0 License](https://pictogrammers.com/docs/general/license/).
Other icons of the Minecraft directory tree view are from [Material Icon Theme](https://github.com/material-extensions/vscode-material-icon-theme) and are under [MIT License](https://github.com/material-extensions/vscode-material-icon-theme/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-minecraft",
"maintainer": null,
"docs_url": null,
"requires_python": "==3.12.*",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "theogiraudet <theo.giraudet@altearn.xyz>, Aksiome <maxime.calmon@altearn.xyz>",
"download_url": "https://files.pythonhosted.org/packages/b8/89/1c39f7808f152df4b87ab2bdaedaadaa54471a8498a82b766221a06f6b4d/sphinx_minecraft-1.0.1.tar.gz",
"platform": null,
"description": "# Sphinx Minecraft\n\nAdd different Minecraft-oriented components to Sphinx.\n\n## Installation\n\n```bash\npip install sphinx-minecraft\n```\n\nAdd the extension to your Sphinx `conf.py`:\n\n```python\nextensions = [\n 'sphinx_minecraft'\n]\n```\n\n## Available components\n\n### Tree views\n\nThese components are based on [sphinx-treeview](https://github.com/Altearn/Sphinx-Tree-View).\n\n#### Minecraft directory tree\n**Usage:**\n```rst\n:::{treeview}\n- {mcdir}`folder` folder\n - {mcdir}`mcfunction` function.mcfunction\n - {mcdir}`mcmeta` pack.mcmeta\n - {mcdir}`nbt` structure.nbt\n- {mcdir}`folder` folder2\n - {mcdir}`file` file.txt\n - {mcdir}`audio` sound.ogg\n - {mcdir}`image` texture.png\n - {mcdir}`json` advancement.json\n - {mcdir}`yml` config.yml\n:::\n```\n**Result:**\n\n\n\n#### NBT tree\n**Usage:**\n```rst\n:::{treeview}\n- {nbt}`compound` A compound tag\n - {nbt}`bool` A boolean tag\n - {nbt}`byte` A byte tag\n - {nbt}`short` A short tag\n - {nbt}`int` An integer tag\n - {nbt}`long` A long tag\n - {nbt}`float` A float tag\n - {nbt}`double` A double tag\n - {nbt}`string` A string tag\n - {nbt}`list` A list tag\n - {nbt}`number` A number tag\n - {nbt}`any` A tag to represent any type\n- {nbt}`compound` A compound tag\n - {nbt}`long-array` A long array tag\n - {nbt}`byte-array` A byte array tag\n - {nbt}`int-array` An integer array tag\n:::\n```\n**Result:**\n\n\n\n# License\n\nThis project is licensed under the MPL-2.0 License. See the [LICENSE](LICENSE) file for details.\nFile and folder icons came from [pictogrammers](https://pictogrammers.com/library/mdi/) and are under [Apache-2.0 License](https://pictogrammers.com/docs/general/license/).\nOther icons of the Minecraft directory tree view are from [Material Icon Theme](https://github.com/material-extensions/vscode-material-icon-theme) and are under [MIT License](https://github.com/material-extensions/vscode-material-icon-theme/blob/main/LICENSE).",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "Add different Minecraft-oriented components to Sphinx.",
"version": "1.0.1",
"project_urls": {
"Issues": "https://github.com/Gunivers/Sphinx-Minecraft/issues",
"Repository": "https://github.com/Gunivers/Sphinx-Minecraft/tree/main"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b497070a8f92ffa742d862828e146ffbce2d0a1d5b9a436868147e39472b100",
"md5": "fcbb5e173d3d0523518b57643f6c5e59",
"sha256": "4b139944ae93bce5d65e13c83625543382a8140565b5cbd841e3ae1a6b8a4294"
},
"downloads": -1,
"filename": "sphinx_minecraft-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fcbb5e173d3d0523518b57643f6c5e59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "==3.12.*",
"size": 42600,
"upload_time": "2024-12-21T14:04:30",
"upload_time_iso_8601": "2024-12-21T14:04:30.171890Z",
"url": "https://files.pythonhosted.org/packages/2b/49/7070a8f92ffa742d862828e146ffbce2d0a1d5b9a436868147e39472b100/sphinx_minecraft-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8891c39f7808f152df4b87ab2bdaedaadaa54471a8498a82b766221a06f6b4d",
"md5": "344a42a60bcaa04b38abbe8f605d7bee",
"sha256": "e8430b749fecd31d61d9d9eff5e838318e8999ce4b81132cd4994012ad1f025d"
},
"downloads": -1,
"filename": "sphinx_minecraft-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "344a42a60bcaa04b38abbe8f605d7bee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "==3.12.*",
"size": 21582,
"upload_time": "2024-12-21T14:04:31",
"upload_time_iso_8601": "2024-12-21T14:04:31.423718Z",
"url": "https://files.pythonhosted.org/packages/b8/89/1c39f7808f152df4b87ab2bdaedaadaa54471a8498a82b766221a06f6b4d/sphinx_minecraft-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 14:04:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Gunivers",
"github_project": "Sphinx-Minecraft",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinx-treeview",
"specs": [
[
"==",
"1.0.1"
]
]
}
],
"lcname": "sphinx-minecraft"
}
JSON
