SkuidSphinxTheme

This repository contains Skuid’s Sphinx theme.

Install

To install, run the following command and input your bitbucket credentials:

pip install skuidsphinxtheme

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',
    ]
)

or add it to the project’s requirements.txt file

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.png',
    'logo_alt': 'Skuid 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
}

analytics_id: Set to your Google Analytics ID (e.g. UA-#######-##) to enable tracking.

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

Document all configurable html_theme options (from the theme.conf)
Figure out how to make html_sidebars option default for projects using this theme
Clean up search results page
- Add search box
- Add some padding on the left of results

Authors

Shannon Hale

Cody Taylor

Metadata

Release files for SkuidSphinxTheme 1.0.23

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for SkuidSphinxTheme 1.0.23
File	Size	Uploaded
SkuidSphinxTheme-1.0.23.tar.gz	568.2 kB	Oct 7, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for SkuidSphinxTheme 1.0.23
File	Interpreter	ABI	Platform	Reset
SkuidSphinxTheme-1.0.23-py2.py3-none-any.whl 577.7 kB Oct 7, 2019	Python 3, Python 2	none	any	Details

Total release size: 1.1 MB

Release files / SkuidSphinxTheme-1.0.23.tar.gz

Download URL	SkuidSphinxTheme-1.0.23.tar.gz
Size	568.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`5820bca181ec529282c9e6d8f3171df89336afc2ab3247efc4056c1283939710`
BLAKE2b-256 checksum How to use checksums	`dbfe28a0309c150d5f208e5e85ec09c19f8ac05518c41d92d95ed7086ddefb1c`
Upload date	Oct 7, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`Python-urllib/3.7`

Release files / SkuidSphinxTheme-1.0.23-py2.py3-none-any.whl

Download URL	SkuidSphinxTheme-1.0.23-py2.py3-none-any.whl
Size	577.7 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`2667977af1e28d7faad4cfac6e0ba93970a539bd8d72fab15493f1d8fcb45975`
BLAKE2b-256 checksum How to use checksums	`7846e301d198278119e4dc2146bf57dbfe7dab2ba8e3e969da9c20359aab37a7`
Upload date	Oct 7, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`Python-urllib/3.7`