Cleverly-named alabaster sub-theme for git-pull projects
Project description
Sphinx sub-theme of Alabaster, for use on git-pull projects.
What alagitpull adds to Alabaster
See the theme live on https://www.git-pull.com, https://tmuxp.git-pull.com, etc.
- Table CSS tweaks
- <pre> and code-block css tweaks
- Additional theming tweaks for admonitions like ..note.
- New sidebar template with links to projects
- Automatic unlinking of project if its the current docs
- Support for subprojects (put into parenthesis)
- Sidebar CSS tweaks
Config options
Theme variables
To see a full list of options passible to HTML templates, see theme.conf. Not all of these options are used in the theme itself, but to let html_theme_options pass them through, if you want.
To configure, conf.py:
html_theme_options example:
html_theme_options = { 'logo': 'img/logo.svg', 'github_user': 'git-pull', 'github_repo': 'alagitpull', 'github_type': 'star', 'github_banner': True, 'projects': {}, 'project_name': 'my project name', }
For an example of html_theme_options['projects'] see the alagitpull/__init__.py file.
Example of using an optional variable such as theme_show_meta_app_icons_tags:
html_theme_options = { # ...usual stuff, as above, and 'project_description': 'description of project' }
{%- if theme_show_meta_app_icon_tags == true %} <meta name="theme-color" content="#ffffff"> <meta name="application-name" content="{{ theme_project_description }}"> <link rel="shortcut icon" href="/_static/favicon.ico"> <link rel="icon" type="image/png" sizes="512x512" href="/_static/img/icons/icon-512x512.png"> <link rel="icon" type="image/png" sizes="192x192" href="/_static/img/icons/icon-192x192.png"> <link rel="icon" type="image/png" sizes="32x32" href="/_static/img/icons/icon-32x32.png"> <link rel="icon" type="image/png" sizes="96x96" href="/_static/img/icons/icon-96x96.png"> <link rel="icon" type="image/png" sizes="16x16" href="/_static/img/icons/icon-16x16.png"> <!-- Apple --> <meta name="apple-mobile-web-app-title" content="{{ theme_project_name }}"> <link rel="apple-touch-icon" sizes="192x192" href="/_static/img/icons/icon-192x192.png"> <link rel="mask-icon" href="/_static/img/{{ theme_project_name }}.svg" color="grey"> <!-- Microsoft --> <meta name="msapplication-TileColor" content="#ffffff"> <meta name="msapplication-TileImage" content="/_static/img/icons/ms-icon-144x144.png"> {% endif -%}
Variables
alagitpull_external_hosts_new_window (boolean, default: False): check if link is external domain/IP. If so, open in new window.
alagitpull_external_hosts_new_window = True
alagitpull_internal_hosts (list) - whitelist of domains to open in same tab, without target="_blank". Only used if alagitpull_external_hosts_new_window enabled.
Example:
alagitpull_internal_hosts = [ 'libtmux.git-pull.com', '0.0.0.0', ]
Theme options
html_theme_options of sphinx’s conf.py:
- projects (dict) - Sidebar links.
- project_name (string) - Name of your project (helps with unlinking
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 alagitpull-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b9ed87ee410c6fa40a63a91d2f25919a10e20c6d39e080356b067f3ff6f379b |
|
MD5 | 00f23ce11980be62a1258787537ac82a |
|
BLAKE2-256 | 116000a75610e0b09a99cb391d6442a562102ac3a08b76ee19e53b66aaa9cfb2 |