Metadata-Version: 2.4
Name: zcnote-sphinx-theme
Version: 0.0.2
Summary: A customized Sphinx theme based on pydata-sphinx-theme.
Author-email: zclab <yshi009@foxmail.com>
License-Expression: BSD-3-Clause
Project-URL: Source, https://github.com/zclab/zcnote-sphinx-theme
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx<10,>=8.0
Requires-Dist: pydata-sphinx-theme<0.18.0,>=0.16.0
Provides-Extra: doc
Requires-Dist: sphinx_design; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Requires-Dist: sphinx_copybutton; extra == "doc"
Requires-Dist: sphinx-togglebutton; extra == "doc"
Dynamic: license-file

# zcnote-sphinx-theme

Modify and build upon [pydata-sphinx-theme](https://pydata-sphinx-theme.readthedocs.io/) with minor style altered.

<!-- start badges -->
[![PyPI](https://img.shields.io/pypi/v/zcnote-sphinx-theme?style=flat-square&logo=python&logoColor=white&color=orange)](https://pypi.org/project/zcnote-sphinx-theme/)
[![status](https://img.shields.io/pypi/status/zcnote-sphinx-theme.svg?style=flat-square)](https://pypi.org/project/zcnote-sphinx-theme/)
[![license](https://img.shields.io/pypi/l/zcnote-sphinx-theme.svg?style=flat-square&logo=opensourceinitiative&logoColor=white)](https://github.com/zclab/zcnote-sphinx-theme/blob/main/LICENSE)


<!-- end badges -->


## Get started

<!-- start quickstart -->

To use this theme in your documentation build environment, first install the `zcnote-sphinx-theme` with `pip`:

```
pip install zcnote-sphinx-theme
```

then, configure the Sphinx docs to use the theme by editing `conf.py`

```python
html_theme = "zcnote_sphinx_theme"
```

Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉

<!-- end quickstart -->

## Documentation
See the [documentation](https://zcnote-sphinx-theme.pages.dev/) for more information.
