Sphinx Theme for Skuid
Project description
This repository contains Skuid’s Sphinx theme.
Install
To install, run the following command and input your bitbucket credentials:
pip install -U -e git+https://bitbucket.org/productengineering/skuidsphinxtheme # Or if you prefer ssh pip install -e git+git@bitbucket.org:productengineering/skuidsphinxtheme.git@HEAD#egg=SkuidSphinxTheme-1.0.0
If you plan on editing this and want to dynamically update this theme for use in another project, clone this repo down and then run:
pip install -e .
Use
To use in another project, add this project to the setup.py file’s install_requires directive:
setup( ... install_requires=[ 'SkuidSphinxTheme>=1.0.0', ] )
Then add in the conf.py of your sphinx project:
html_theme = 'skuidsphinx' # TODO: We'd like this rolled into the theme, hopefully we can remove this later html_sidebars = {'**': ['localtoc.html']}
Theme Options
To configure the theme for your project, you’ll need to configure the html_theme_options in your project’s conf.py file. See the variables section below for a full list of options.
html_theme_options = { 'logo': 'skuid_developers.png', 'logo_alt': 'Skuid Developer Documentation', }
Variables
logo: Relative path (from $PROJECT/_static/) to a logo image, which will appear in the upper left corner above the name of the project.
See the note below about image paths.
logo_alt: The alt text for the logo
visit_link: The link for the visit button in the footer
visit_link_text: The text for the visit button in the footer
copyright_year: The year for the copyright.
To make things easier, add the following to your conf.py:
# At the top from datetime import datetime # in the ``html_theme_options`` html_theme_options = { 'copyright_year': datetime.utcnow().year }
Images
If you’re using a custom logo, you’ll also want to tell Sphinx where to get your images from. If so, add a line like this (changing the path if necessary; see the Sphinx docs for ‘html_static_path’):
html_static_path = ['_static']
TODO
Change logo to Skuid logo without text, put document title next to logo
Document all configurable html_theme options (from the theme.conf)
Figure out how to make html_sidebars option default for projects using this theme
Edit layout.html to fix the hardcoded “Local TOC”
Fix the page-width overflow issue (it pushes the sidebar-local over the right edge of the page)
Fix the hardcoded links at the top
Make TOC sub-headings indent properly (on index page)
Clean up search results page
Add search box
Add some padding on the left of results
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for SkuidSphinxTheme-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72a8078f6c182d9c47503898fa92c09689f4163abf225c8c53dc1c5714581a2b |
|
MD5 | 850f20f9db269421d8145c71a9b959dc |
|
BLAKE2b-256 | e07a89a0979a644e5480ac3e4068d910c87b403ceb912c70b301a099fbcc7490 |