https://github.com/lepture/shibuya

A responsive, good looking with modern design documentation theme for Sphinx, with great supports for many sphinx extensions.
https://github.com/lepture/shibuya

documentation sphinx-doc sphinx-theme

Last synced: about 2 months ago
JSON representation

A responsive, good looking with modern design documentation theme for Sphinx, with great supports for many sphinx extensions.

• Host: GitHub
• URL: https://github.com/lepture/shibuya
• Owner: lepture
• License: bsd-3-clause
• Created: 2023-02-13T13:38:15.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-28T12:26:28.000Z (about 1 year ago)
• Last Synced: 2024-05-02T00:03:11.052Z (about 1 year ago)
• Topics: documentation, sphinx-doc, sphinx-theme
• Language: CSS
• Homepage: https://shibuya.lepture.com
• Size: 4.95 MB
• Stars: 144
• Watchers: 5
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing/index.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

  

  





[![PyPi](https://img.shields.io/pypi/v/shibuya?style=for-the-badge)](https://pypi.python.org/pypi/shibuya)

[![Documentation](https://img.shields.io/badge/documentation-6E56CF?style=for-the-badge&logo=python&logoColor=white)](https://shibuya.lepture.com/)

[![GitHub Sponsors](https://img.shields.io/github/sponsors/lepture?color=E54666&style=for-the-badge)](https://github.com/sponsors/lepture)



---

Shibuya, a beautiful, modern, and responsive theme for Sphinx documentation generator, with great supports for Jupyter extensions.

![preview](https://github.com/lepture/shibuya/assets/290496/c754e460-8684-4e61-9ae1-9dc4ed9593d0)

## Quick start

Install Shibuya theme with `pip`:

```

pip install shibuya

```

Add shibuya theme to your Sphinx `conf.py`:

```python

html_theme = "shibuya"

```

## License

BSD 3-Clause License