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 = Truealagitpull_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
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
File details
Details for the file alagitpull-0.0.26rc1.tar.gz.
File metadata
- Download URL: alagitpull-0.0.26rc1.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7ae92e14650a1940f9c734350c259acc558743022e467e137d930df9a3109ea1 |
|
| MD5 | 9dcf4b8855c4efa05e087005be0f7b2c |
|
| BLAKE2b-256 | 2febbd0d4383195d23b0dc059e847157a4315360dacf7a6d395b42c75db474c0 |
