https://github.com/git-pull/alagitpull
alabaster sub-theme used on git-pull docs
https://github.com/git-pull/alagitpull
alabaster sphinx theme
Last synced: about 1 month ago
JSON representation
alabaster sub-theme used on git-pull docs
- Host: GitHub
- URL: https://github.com/git-pull/alagitpull
- Owner: git-pull
- License: mit
- Created: 2017-05-26T15:06:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T23:24:22.000Z (about 2 years ago)
- Last Synced: 2025-09-30T01:24:06.035Z (5 months ago)
- Topics: alabaster, sphinx, theme
- Language: Python
- Size: 43.9 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES
- License: LICENSE
Awesome Lists containing this project
README
=====================
git-pull sphinx theme
=====================
`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
- ``
`` 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:
.. code-block:: python
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``:
.. code-block:: python
html_theme_options = {
# ...usual stuff, as above, and
'project_description': 'description of project'
}
.. code-block:: html
{%- if theme_show_meta_app_icon_tags == true %}
{% endif -%}
Variables
"""""""""
*alagitpull_external_hosts_new_window* (boolean, default: False): check if link
is external domain/IP. If so, open in new window.
.. code-block:: python
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:
.. code-block:: python
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
.. _Sphinx: http://www.sphinx-doc.org/
.. _Alabaster: https://github.com/bitprophet/alabaster
.. _admonitions: http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions