https://github.com/jdknight/sphinx-alice-theme
Provides the Alice theme for Sphinx projects.
https://github.com/jdknight/sphinx-alice-theme
sphinx sphinx-theme
Last synced: 22 days ago
JSON representation
Provides the Alice theme for Sphinx projects.
- Host: GitHub
- URL: https://github.com/jdknight/sphinx-alice-theme
- Owner: jdknight
- License: bsd-2-clause
- Created: 2020-02-29T17:20:25.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-19T21:13:23.000Z (over 1 year ago)
- Last Synced: 2025-04-20T22:18:44.528Z (about 1 month ago)
- Topics: sphinx, sphinx-theme
- Language: CSS
- Homepage: https://sphinx-alice-theme.jdknight.me/
- Size: 1.17 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
# Alice Theme for Sphinx
[][PyPi]
[][Build]
[][Documentation]
Provides the Alice theme for [Sphinx][Sphinx] projects.
## Installation
This theme can be installed using [pip][pip]:
```shell
pip install -U sphinx-alice-theme
(or)
python -m pip install -U sphinx-alice-theme
```
## Usage
For an existing Sphinx documentation set, the Alice theme can be applied by
configuring the [`html_theme`][html_theme] value to `sphinx_alice_theme`.
For example:
```python
html_theme = 'sphinx_alice_theme'
```
The following theme options are available:
```python
html_theme_options = {
#'canonical_url': 'https://www.example.com',
#'includehidden': False,
#'navigation_depth': 4,
#'prev_next_buttons_location': 'both', # top, bottom, none
#'titles_only': False,
}
```
## Dependencies
- [Gumshoe][Gumshoe]
[Build]: https://github.com/jdknight/sphinx-alice-theme/actions/workflows/build.yml
[Documentation]: https://sphinx-alice-theme.jdknight.me/
[Gumshoe]: https://github.com/cferdinandi/gumshoe
[PyPi]: https://pypi.org/project/sphinx-alice-theme/
[Sphinx]: https://www.sphinx-doc.org/
[html_theme]: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme
[pip]: https://pip.pypa.io/