Metadata-Version: 2.3
Name: sphinx_godot
Version: 0.0.7
Summary: A Sphinx theme based on the official Godot documentation.
Author-email: opsocket <opsocket@pm.me>
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Dist: sphinx
Requires-Dist: sphinx_rtd_theme
Requires-Dist: sphinx-autobuild
Requires-Dist: pygments
Requires-Dist: sphinx-tabs
Requires-Dist: sphinx-copybutton
Requires-Dist: sphinx-notfound-page
Requires-Dist: sphinxext-opengraph
Requires-Dist: sphinxcontrib-video
Requires-Dist: black ; extra == "dev"
Requires-Dist: flake8 ; extra == "dev"
Requires-Dist: flit ; extra == "dev"
Requires-Dist: build ; extra == "dev"
Requires-Dist: twine ; extra == "dev"
Project-URL: Homepage, https://gitlab.com/opsocket/sphinx_godot.git
Project-URL: Issues, https://gitlab.com/opsocket/sphinx_godot/-/issues
Provides-Extra: dev

# sphinx-godot

<a href="#">
  <img src="https://img.shields.io/badge/%F0%9F%94%96%20Version-0.0.7-ec3832.svg?color=ec3832&style=flat" />
</a>

## ⚙️ Installation

This theme is distributed on [PyPI][pypi] and can be installed with `pip`:

```shell
pip install sphinx-godot
```

To use the theme in your Sphinx project, you will need to edit your `conf.py` file’s `html_theme` setting:

```python
html_theme = "godot"
```

## 📝 License

The theme is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html).
See [LICENSE.md](LICENSE.md) for more details

It is also derived from the [Godot Engine][godot-engine]'s [documentation][godot-docs] dedicated [repository][godot-docs-repo].
See [THIRDPARTY.md](THIRDPARTY.md) for more details.

## 📸 Preview

<div align="center">
  <img src="https://gitlab.com/opsocket/sphinx_godot/-/raw/main/assets/img/preview.png"  width="800" height="671">
</div>

[godot-docs-repo]: https://github.com/godotengine/godot-docs
[godot-docs]: https://docs.godotengine.org
[godot-engine]: https://github.com/godotengine/godot
[pypi]: https://pypi.org/project/sphinx-godot
