# sphinx-orange-book-theme
[](https://pypi.org/project/sphinx-orange-book-theme/)
[](https://github.com/pre-commit/pre-commit)
An orange version of [sphinx-book-theme](https://sphinx-book-theme.readthedocs.io/en/latest/index.html).
This python package overrides CSS of sphinx-book-theme
to change its design.
For an example of built document, see
[Documentation built on main branch](https://sphinx-orange-book-theme-musicscience37projects--1dc46f9ab80e60.gitlab.io/).
## Usage
To use this theme,
1. Install
[sphinx-orange-book-theme](https://pypi.org/project/sphinx-orange-book-theme/)
package from PyPI, for example, using the following command:
```shell
pip install sphinx-orange-book-theme
```
2. Update your conf.py file to use `sphinx_orange_book_theme` theme as following:
```python
html_theme = "sphinx_orange_book_theme"
```
3. (Recommended) Add following options to conf.py:
```python
html_theme_options = {
"pygment_light_style": "gruvbox-light",
"pygment_dark_style": "native",
}
```
Although these options are not required to use this theme,
this theme is designed with the above options.
## Documentation
- [Documentation built on main branch](https://sphinx-orange-book-theme-musicscience37projects--1dc46f9ab80e60.gitlab.io/)
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/MusicScience37Projects/utility-libraries/sphinx-orange-book-theme",
"name": "sphinx-orange-book-theme",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "sphinx",
"author": "Kenta Kabashima",
"author_email": "kenta_program37@hotmail.co.jp",
"download_url": "https://files.pythonhosted.org/packages/bb/24/c6c68f4bc3042f8a3346166071d710d939f31866f6a93de13aa5fd8820cd/sphinx_orange_book_theme-0.8.0.tar.gz",
"platform": null,
"description": "# sphinx-orange-book-theme\n\n\n[](https://pypi.org/project/sphinx-orange-book-theme/)\n\n\n[](https://github.com/pre-commit/pre-commit)\n\nAn orange version of [sphinx-book-theme](https://sphinx-book-theme.readthedocs.io/en/latest/index.html).\n\nThis python package overrides CSS of sphinx-book-theme\nto change its design.\n\nFor an example of built document, see\n[Documentation built on main branch](https://sphinx-orange-book-theme-musicscience37projects--1dc46f9ab80e60.gitlab.io/).\n\n## Usage\n\nTo use this theme,\n\n1. Install\n [sphinx-orange-book-theme](https://pypi.org/project/sphinx-orange-book-theme/)\n package from PyPI, for example, using the following command:\n\n ```shell\n pip install sphinx-orange-book-theme\n ```\n\n2. Update your conf.py file to use `sphinx_orange_book_theme` theme as following:\n\n ```python\n html_theme = \"sphinx_orange_book_theme\"\n ```\n\n3. (Recommended) Add following options to conf.py:\n\n ```python\n html_theme_options = {\n \"pygment_light_style\": \"gruvbox-light\",\n \"pygment_dark_style\": \"native\",\n }\n ```\n\n Although these options are not required to use this theme,\n this theme is designed with the above options.\n\n## Documentation\n\n- [Documentation built on main branch](https://sphinx-orange-book-theme-musicscience37projects--1dc46f9ab80e60.gitlab.io/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An orange version of sphinx-book-theme.",
"version": "0.8.0",
"project_urls": {
"Documentation": "https://sphinx-orange-book-theme-musicscience37projects--1dc46f9ab80e60.gitlab.io/",
"Homepage": "https://gitlab.com/MusicScience37Projects/utility-libraries/sphinx-orange-book-theme",
"Repository": "https://gitlab.com/MusicScience37Projects/utility-libraries/sphinx-orange-book-theme.git"
},
"split_keywords": [
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea3342f801c3413f986387402501775ccdd7ad71867e688e0f909f9509dc1c8c",
"md5": "d5836163d3ac3fac8201dbbcec33da87",
"sha256": "504c79d23b3aa91f1624cf51120bd085cf35879ed7fc952082d005c34dcc087d"
},
"downloads": -1,
"filename": "sphinx_orange_book_theme-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5836163d3ac3fac8201dbbcec33da87",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 5346,
"upload_time": "2024-04-29T16:24:03",
"upload_time_iso_8601": "2024-04-29T16:24:03.726313Z",
"url": "https://files.pythonhosted.org/packages/ea/33/42f801c3413f986387402501775ccdd7ad71867e688e0f909f9509dc1c8c/sphinx_orange_book_theme-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb24c6c68f4bc3042f8a3346166071d710d939f31866f6a93de13aa5fd8820cd",
"md5": "4c54a8430877d5270c5946f8ed37ac57",
"sha256": "080c896a3a3fe5eb40d306e3237fe51fecfbdb904ad385557e2e8e6299b5facb"
},
"downloads": -1,
"filename": "sphinx_orange_book_theme-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "4c54a8430877d5270c5946f8ed37ac57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 3903,
"upload_time": "2024-04-29T16:24:05",
"upload_time_iso_8601": "2024-04-29T16:24:05.020531Z",
"url": "https://files.pythonhosted.org/packages/bb/24/c6c68f4bc3042f8a3346166071d710d939f31866f6a93de13aa5fd8820cd/sphinx_orange_book_theme-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 16:24:05",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "MusicScience37Projects",
"gitlab_project": "utility-libraries",
"lcname": "sphinx-orange-book-theme"
}
JSON