Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

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,, 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,

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/ 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 -%}


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.


alagitpull_internal_hosts = [

Theme options

html_theme_options of sphinx’s

  • projects (dict) - Sidebar links.
  • project_name (string) - Name of your project (helps with unlinking

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for alagitpull, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size alagitpull-0.1.0-py2.py3-none-any.whl (8.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size alagitpull-0.1.0.tar.gz (7.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page