Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to upstream version 0.7.16 #9

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE → LICENSE.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2018 Jeff Forcier.
Copyright (c) 2020 Jeff Forcier.

Based on original work copyright (c) 2011 Kenneth Reitz and copyright (c) 2010
Armin Ronacher.
Expand Down
4 changes: 0 additions & 4 deletions MANIFEST.in

This file was deleted.

94 changes: 57 additions & 37 deletions PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,47 +1,67 @@
Metadata-Version: 1.1
Metadata-Version: 2.1
Name: alabaster
Version: 0.7.12
Summary: A configurable sidebar-enabled Sphinx theme
Home-page: https://alabaster.readthedocs.io
Author: Jeff Forcier
Author-email: [email protected]
License: UNKNOWN
Description: What is Alabaster?
==================

Alabaster is a visually (c)lean, responsive, configurable theme for the `Sphinx
<http://sphinx-doc.org>`_ documentation system. It is Python 2+3 compatible.

It began as a third-party theme, and is still maintained separately, but as of
Sphinx 1.3, Alabaster is an install-time dependency of Sphinx and is selected
as the default theme.

Live examples of this theme can be seen on `this project's own website
<http://alabaster.readthedocs.io>`_, `paramiko.org <http://paramiko.org>`_,
`fabfile.org <http://fabfile.org>`_ and `pyinvoke.org <http://pyinvoke.org>`_.

For more documentation, please see http://alabaster.readthedocs.io.

.. note::
You can install the development version via ``pip install -e
git+https://github.com/bitprophet/alabaster/#egg=alabaster``.

Platform: UNKNOWN
Version: 0.7.16
Summary: A light, configurable Sphinx theme
Author-email: Jeff Forcier <[email protected]>
Maintainer: The Sphinx Developers
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Project-URL: Changelog, https://alabaster.readthedocs.io/en/latest/changelog.html
Project-URL: Documentation, https://alabaster.readthedocs.io/
Project-URL: Download, https://pypi.org/project/alabaster/
Project-URL: Homepage, https://alabaster.readthedocs.io/
Project-URL: Issue tracker, https://github.com/bitprophet/alabaster/issues
Project-URL: Source, https://github.com/sphinx-doc/alabaster

.. image:: https://img.shields.io/pypi/v/alabaster.svg
:target: https://pypi.org/project/alabaster/
:alt: Package on PyPI

.. image:: https://github.com/sphinx-doc/alabaster/actions/workflows/test.yml/badge.svg
:target: https://github.com/sphinx-doc/alabaster/actions/workflows/test.yml
:alt: CI Status

.. image:: https://readthedocs.org/projects/alabaster/badge/
:target: https://alabaster.readthedocs.io/
:alt: Documentation Status

.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://opensource.org/license/BSD-3-Clause
:alt: BSD 3 Clause


What is Alabaster?
==================

Alabaster is a visually (c)lean, responsive, configurable theme for the `Sphinx
<https://www.sphinx-doc.org>`_ documentation system.
It requires Python 3.9 or newer and Sphinx 3.4 or newer.

It began as a third-party theme, and is still maintained separately, but as of
Sphinx 1.3, Alabaster is an install-time dependency of Sphinx and is selected
as the default theme.

Live examples of this theme can be seen on `this project's own website
<https://alabaster.readthedocs.io/>`_, `paramiko.org <https://www.paramiko.org>`_,
`fabfile.org <https://www.fabfile.org>`_ and `pyinvoke.org <https://www.pyinvoke.org>`_.

For more documentation, please see https://alabaster.readthedocs.io/.

30 changes: 22 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,33 @@
.. image:: https://img.shields.io/pypi/v/alabaster.svg
:target: https://pypi.org/project/alabaster/
:alt: Package on PyPI

.. image:: https://github.com/sphinx-doc/alabaster/actions/workflows/test.yml/badge.svg
:target: https://github.com/sphinx-doc/alabaster/actions/workflows/test.yml
:alt: CI Status

.. image:: https://readthedocs.org/projects/alabaster/badge/
:target: https://alabaster.readthedocs.io/
:alt: Documentation Status

.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://opensource.org/license/BSD-3-Clause
:alt: BSD 3 Clause


What is Alabaster?
==================

Alabaster is a visually (c)lean, responsive, configurable theme for the `Sphinx
<http://sphinx-doc.org>`_ documentation system. It is Python 2+3 compatible.
<https://www.sphinx-doc.org>`_ documentation system.
It requires Python 3.9 or newer and Sphinx 3.4 or newer.

It began as a third-party theme, and is still maintained separately, but as of
Sphinx 1.3, Alabaster is an install-time dependency of Sphinx and is selected
as the default theme.

Live examples of this theme can be seen on `this project's own website
<http://alabaster.readthedocs.io>`_, `paramiko.org <http://paramiko.org>`_,
`fabfile.org <http://fabfile.org>`_ and `pyinvoke.org <http://pyinvoke.org>`_.

For more documentation, please see http://alabaster.readthedocs.io.
<https://alabaster.readthedocs.io/>`_, `paramiko.org <https://www.paramiko.org>`_,
`fabfile.org <https://www.fabfile.org>`_ and `pyinvoke.org <https://www.pyinvoke.org>`_.

.. note::
You can install the development version via ``pip install -e
git+https://github.com/bitprophet/alabaster/#egg=alabaster``.
For more documentation, please see https://alabaster.readthedocs.io/.
47 changes: 0 additions & 47 deletions alabaster.egg-info/PKG-INFO

This file was deleted.

21 changes: 0 additions & 21 deletions alabaster.egg-info/SOURCES.txt

This file was deleted.

1 change: 0 additions & 1 deletion alabaster.egg-info/dependency_links.txt

This file was deleted.

3 changes: 0 additions & 3 deletions alabaster.egg-info/entry_points.txt

This file was deleted.

1 change: 0 additions & 1 deletion alabaster.egg-info/top_level.txt

This file was deleted.

25 changes: 18 additions & 7 deletions alabaster/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import os

from alabaster import _version as version
__version_info__ = (0, 7, 16)
__version__ = "0.7.16"


def get_path():
Expand All @@ -12,13 +13,23 @@ def get_path():


def update_context(app, pagename, templatename, context, doctree):
context["alabaster_version"] = version.__version__
context["alabaster_version"] = __version__
context["alabaster_version_info"] = __version_info__

# Convert 'show_powered_by' in the theme options to
# the preferred option, html_show_sphinx.
html_theme_options = app.config.html_theme_options
if "show_powered_by" in html_theme_options:
show_powered_by = html_theme_options["show_powered_by"]
if isinstance(show_powered_by, str):
context["show_sphinx"] = show_powered_by.lower() == "true"
else:
context["show_sphinx"] = bool(show_powered_by) # to allow int values


def setup(app):
# add_html_theme is new in Sphinx 1.6+
if hasattr(app, "add_html_theme"):
theme_path = os.path.abspath(os.path.dirname(__file__))
app.add_html_theme("alabaster", theme_path)
app.require_sphinx("3.4")
theme_path = os.path.abspath(os.path.dirname(__file__))
app.add_html_theme("alabaster", theme_path)
app.connect("html-page-context", update_context)
return {"version": version.__version__, "parallel_read_safe": True}
return {"version": __version__, "parallel_read_safe": True}
2 changes: 0 additions & 2 deletions alabaster/_version.py

This file was deleted.

4 changes: 3 additions & 1 deletion alabaster/about.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{% if theme_logo %}
<p class="logo">
<a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' ~ theme_logo, 1) }}" alt="Logo"/>
<img class="logo" src="{{ pathto('_static/' ~ theme_logo, 1) }}" alt="Logo" />
{% if theme_logo_name|lower == 'true' %}
<h1 class="logo logo-name">{{ project }}</h1>
{% elif theme_logo_name|lower != 'false' %}
<h1 class="logo logo-name">{{ theme_logo_name }}</h1>
{% endif %}
</a>
</p>
Expand Down
25 changes: 13 additions & 12 deletions alabaster/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
{% if theme_touch_icon %}
<link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" />
{% endif %}
{% if theme_canonical_url %}
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>

{# Deprecated in favor of html_baseurl (pageurl). This is already set in the basic theme #}
{% if theme_canonical_url and not pageurl %}
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html" />
{% endif %}
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
{% endblock %}

{# top+bottom related navs; we also have our own in sidebar #}
Expand Down Expand Up @@ -86,27 +87,27 @@

{%- block footer %}
<div class="footer">
{% if show_copyright %}&copy;{{ copyright }}.{% endif %}
{% if theme_show_powered_by|lower == 'true' %}
{% if show_copyright %}&#169;{{ copyright }}.{% endif %}
{% if show_sphinx %}
{% if show_copyright %}|{% endif %}
Powered by <a href="http://sphinx-doc.org/">Sphinx {{ sphinx_version }}</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster {{ alabaster_version }}</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx {{ sphinx_version }}</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster {{ alabaster_version }}</a>
{% endif %}
{%- if show_source and has_source and sourcename %}
{% if show_copyright or theme_show_powered_by %}|{% endif %}
{% if show_copyright or show_sphinx %}|{% endif %}
<a href="{{ pathto('_sources/' + sourcename, true)|e }}"
rel="nofollow">{{ _('Page source') }}</a>
{%- endif %}
</div>

{% if theme_github_banner|lower != 'false' %}
<a href="https://github.com/{{ theme_github_user }}/{{ theme_github_repo }}" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ pathto('_static/' ~ theme_github_banner, 1) if theme_github_banner|lower != 'true' else 'https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png' }}" alt="Fork me on GitHub" class="github"/>
<img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ pathto('_static/' ~ theme_github_banner, 1) if theme_github_banner|lower != 'true' else 'https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png' }}" alt="Fork me on GitHub" class="github"/>
</a>
{% endif %}

{% if theme_analytics_id %}
<script type="text/javascript">
<script>

var _gaq = _gaq || [];
_gaq.push(['_setAccount', '{{ theme_analytics_id }}']);
Expand All @@ -115,8 +116,8 @@
_gaq.push(['_trackPageview']);

(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var ga = document.createElement('script'); ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();

Expand Down
Loading