Metadata-Version: 2.1
Name: bulma-sphinx-theme
Version: 0.2.1
Summary: A sphinx theme based on bulma.
Author-Email: zclab <syfhub@hotmail.com>
License: MIT License
        
        Copyright (c) 2023 zc
        
        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.
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Project-URL: Repository, https://github.com/zclab/bulma-sphinx-theme
Project-URL: Documentation, https://bulma-sphinx-theme.readthedocs.io/en/latest/
Requires-Python: >=3.8
Requires-Dist: beautifulsoup4
Requires-Dist: sphinx<8.0,>=5.0
Requires-Dist: sphinx-basic-ng
Requires-Dist: pygments>=2.7
Requires-Dist: sphinx-theme-builder[cli]>=0.2.0b2; extra == "dev"
Provides-Extra: dev
Description-Content-Type: text/markdown

<h1 align="center">
  Bulma Sphinx Theme
</h1>

<p align="center">
  <strong>
    A <a href="https://bulma.io/">bulma</a> based <a href="https://www.sphinx-doc.org/en/master/">sphinx</a> theme.
  </strong>
</p>

<!-- start badges -->

[![deploy](https://img.shields.io/readthedocs/bulma-sphinx-theme?style=flat-square&logo=readthedocs&logoColor=white)](https://bulma-sphinx-theme.readthedocs.io/en/latest/)
[![Downloads](https://img.shields.io/pypi/dm/bulma-sphinx-theme.svg?style=flat-square)](https://pypistats.org/packages/bulma-sphinx-theme)
[![PyPI](https://img.shields.io/pypi/v/bulma-sphinx-theme?style=flat-square&logo=python&logoColor=white&color=orange)](https://pypi.org/project/bulma-sphinx-theme/)
[![status](https://img.shields.io/pypi/status/bulma-sphinx-theme.svg?style=flat-square)](https://pypi.org/project/bulma-sphinx-theme/)
[![license](https://img.shields.io/pypi/l/bulma-sphinx-theme.svg?style=flat-square&logo=opensourceinitiative&logoColor=white)](https://github.com/zclab/bulma-sphinx-theme/blob/main/LICENSE)
[![Github Stars](https://img.shields.io/github/stars/zclab/bulma-sphinx-theme?style=flat-square&logo=github)](https://github.com/zclab/bulma-sphinx-theme)

<!-- end badges -->

## Get started

<!-- start quickstart -->

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

```
pip install bulma-sphinx-theme
```

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

```python
html_theme = "bulma_sphinx_theme"
```

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

<!-- end quickstart -->

## Examples

An examples without fixed navbar: <https://zclab.github.io/bst-demo/>

An examples without navbar: <https://zclab.github.io/bst-nonavbar/>

## Documentation

See [the bulma sphinx theme](https://bulma-sphinx-theme.readthedocs.io/en/latest/) for more information. Your can also refer to [Bulma Documentation](https://bulma.io/) for more sophisticated change.
