# 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 = {
"pygments_light_style": "gruvbox-light",
"pygments_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/02/4c/ac10d063586cbfb7bb7ba62bd356c55ac173ed32f095054a07198ed32b0f/sphinx_orange_book_theme-0.14.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 \"pygments_light_style\": \"gruvbox-light\",\n \"pygments_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.14.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": "829aea7de85744c05cabaaaa05ce37cae16e490f584332cdd990dbed110c724c",
"md5": "c673465c1bb1bc64b9f61cf6f8deb327",
"sha256": "039274fcf914363fe893740b8d6d1185a18aa691d546eddc78b4ee1e81623739"
},
"downloads": -1,
"filename": "sphinx_orange_book_theme-0.14.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c673465c1bb1bc64b9f61cf6f8deb327",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 5508,
"upload_time": "2024-11-01T13:24:40",
"upload_time_iso_8601": "2024-11-01T13:24:40.035789Z",
"url": "https://files.pythonhosted.org/packages/82/9a/ea7de85744c05cabaaaa05ce37cae16e490f584332cdd990dbed110c724c/sphinx_orange_book_theme-0.14.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "024cac10d063586cbfb7bb7ba62bd356c55ac173ed32f095054a07198ed32b0f",
"md5": "6f6cecb11711e735e81989997bd14a39",
"sha256": "700a9e401c38898d651f4c4b7ef46992719c588ab6afec604ba3860b56aa1a7d"
},
"downloads": -1,
"filename": "sphinx_orange_book_theme-0.14.0.tar.gz",
"has_sig": false,
"md5_digest": "6f6cecb11711e735e81989997bd14a39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 4066,
"upload_time": "2024-11-01T13:24:40",
"upload_time_iso_8601": "2024-11-01T13:24:40.992888Z",
"url": "https://files.pythonhosted.org/packages/02/4c/ac10d063586cbfb7bb7ba62bd356c55ac173ed32f095054a07198ed32b0f/sphinx_orange_book_theme-0.14.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 13:24:40",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "MusicScience37Projects",
"gitlab_project": "utility-libraries",
"lcname": "sphinx-orange-book-theme"
}
JSON