https://github.com/the-allanc/allanc_sphinx
Custom Sphinx themes for the documentation of my projects.
https://github.com/the-allanc/allanc_sphinx
sphinx-theme
Last synced: about 1 year ago
JSON representation
Custom Sphinx themes for the documentation of my projects.
- Host: GitHub
- URL: https://github.com/the-allanc/allanc_sphinx
- Owner: the-allanc
- Created: 2017-05-01T09:56:28.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-08T13:25:43.000Z (over 5 years ago)
- Last Synced: 2025-02-27T23:08:28.861Z (over 1 year ago)
- Topics: sphinx-theme
- Language: HTML
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
Custom Sphinx themes for the documentation of `my projects `_.
Themes
======
- **yeen**: Slight modification of the `TriAx Corp `_ theme.
- Defaults to blue colours and sidebar on the left.
- Field lists now use the *mainlightcolor* option for the background colour for headers, rather than a hardcoded blue colour.
- Optionally adds a Github "Octocat" banner to the repository (created by `Tim Holman `_).
Usage
=====
To use the theme, specify ``allanc_sphinx[yeen]`` as a dependency, and in your ``conf.py`` file::
html_theme = 'yeen'
If you want to add the Octocat banner, you just need to define the link you want to go to - for example::
html_theme_options = {'github_url': 'https://github.com/the-allanc/allanc_sphinx'}