Skip to main content

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

Inside conf.py:

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


Download files

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

Source Distribution

alagitpull-0.0.17.tar.gz (8.8 kB view details)

Uploaded Source

File details

Details for the file alagitpull-0.0.17.tar.gz.

File metadata

  • Download URL: alagitpull-0.0.17.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for alagitpull-0.0.17.tar.gz
Algorithm Hash digest
SHA256 71a5e0fb6d75b65eaa08c6ce05720155597eb5f1cedf3aecc5053c4099d4477c
MD5 9a19c88b4a069ba199d24d5f2edb1fd5
BLAKE2b-256 1d79b786bf4dfad594b28e3d35a4ec341bea81fb371c25651111b461ec870098

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page