<commit_before>=========================
Alabaster: a Sphinx theme
=========================

This theme is a modified "Kr" Sphinx theme from @kennethreitz (especially as
used in his `Requests <http://python-requests.org>`_ project), which was
itself originally based on @mitsuhiko's theme used for `Flask
<http://flask.pocoo.org/>`_ & related projects.

Live examples of this theme can be seen on `paramiko.org
<http://paramiko.org>`_, `fabfile.org <http://fabfile.org>`_ and `pyinvoke.org
<http://pyinvoke.org>`_.

A changelog_ can be found at the bottom of this page.

Alabaster is Python 2+3 compatible.


Features
========

Specifically, as compared to Kenneth's theme:

* Easy ability to install/use as a Python package (tip o' the hat to `Dave &
  Eric's sphinx_rtd_theme <https://github.com/snide/sphinx_rtd_theme>`_ for
  showing the way);
* Style tweaks, such as better code-block alignment, Gratipay and Github button
  placement, page source link moved to footer, improved (optional)
  related-items sidebar item, etc;
* Many customization hooks, including toggle of various sidebar & footer
  components; header/link/etc color control; etc;
* Improved documentation for all customizations (pre-existing & new).


Installation
============

The bare minimum required to install is as follows:

#. ``pip install alabaster`` (or equivalent).
#. Enable the 'alabaster' theme, mini-extension, and sidebar templates in your
   ``conf.py``:
   
   .. code-block:: python
    
        import alabaster
        
        html_theme_path = [alabaster.get_path()]
        extensions = ['alabaster']
        html_theme = 'alabaster'
        html_sidebars = {
            '**': [
                'about.html',
                'navigation.html',
                'relations.html',
                'searchbox.html',
                'donate.html',<commit_msg>Tweaks to README, mostly layout<commit_after>=========================
Alabaster: a Sphinx theme
=========================

This theme is a modified "Kr" Sphinx theme from @kennethreitz (especially as
used in his `Requests <http://python-requests.org>`_ project), which was itself
originally based on @mitsuhiko's theme used for `Flask
<http://flask.pocoo.org/>`_ & related projects.

Live examples of this theme can be seen on `paramiko.org
<http://paramiko.org>`_, `fabfile.org <http://fabfile.org>`_ and `pyinvoke.org
<http://pyinvoke.org>`_.

A changelog_ can be found at the bottom of this page.

Alabaster is Python 2+3 compatible.


Features
========

Specifically, as compared to Kenneth's theme:

* Easy ability to install/use as a Python package (tip o' the hat to `Dave &
  Eric's sphinx_rtd_theme <https://github.com/snide/sphinx_rtd_theme>`_ for
  showing the way);
* Style tweaks, such as better code-block alignment, Github button placement,
  page source link moved to footer, improved (optional) related-items sidebar
  item, etc;
* Many customization hooks, including toggle of various sidebar & footer
  components; header/link/etc color control; etc;
* Improved documentation for all customizations (pre-existing & new).


Installation
============

The bare minimum required to install is as follows:

#. ``pip install alabaster`` (or equivalent).
#. Enable the 'alabaster' theme, mini-extension, and sidebar templates in your
   ``conf.py``:
   
   .. code-block:: python
    
        import alabaster
        
        html_theme_path = [alabaster.get_path()]
        extensions = ['alabaster']
        html_theme = 'alabaster'
        html_sidebars = {
            '**': [
                'about.html',
                'navigation.html',
                'relations.html',
                'searchbox.html',
                'donate.html',
{'fraction_non_alphanumeric': 0.13546997037436034, 'fraction_numerical': 0.0010772959870724481, 'mean_word_length': 3.2738780207134637, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7072421', 'n_tokens_mistral': 1120, 'n_tokens_neox': 1057, 'n_words': 369}