<commit_before># Modified 'Kr/Flask' Sphinx theme

This repository is a modified "Kr" Sphinx theme from @kennethreitz, which was
in turn modfied from @mitsuhiko's theme used for Flask & related projects.

I named the theme itself back to "flasky" (reflecting that it's relatively
generic and not used for Kenneth's own projects, but my own or anybody else's
use) and tried to polish it up. To wit, changes from Kenneth's theme:

* No 'small' theme since I didn't need it & wanted to remove noise;
* Minor style tweaks, such as ensuring code blocks left-align with regular text
  blocks (in Kenneth's theme they are dedented too far);
* Additional customization hooks, such as header/link/etc colors;
* Improved documentation for all customizations (pre-existing & new).

To use:

1. Use this folder as the `_themes` subdirectory of your Sphinx project (copy
   it, use a git submodule, whatever.)
2. Add to your `conf.py`:

    import os
    import sys

    sys.path.append(os.path.abspath('_themes'))
    html_theme_path = ['_themes']
    html_theme = 'flasky'

TK: documented customization hooks<commit_msg>Trying to update README format re: option stuff. WIP.<commit_after># Modified 'Kr/Flask' Sphinx theme

This repository is a modified "Kr" Sphinx theme from @kennethreitz, which was
in turn modfied from @mitsuhiko's theme used for Flask & related projects.

I named the theme itself back to "flasky" (reflecting that it's relatively
generic and not used for Kenneth's own projects, but my own or anybody else's
use) and tried to polish it up. To wit, changes from Kenneth's theme:

* No 'small' theme since I didn't need it & wanted to remove noise;
* Minor style tweaks, such as ensuring code blocks left-align with regular text
  blocks (in Kenneth's theme they are dedented too far);
* Additional customization hooks, such as header/link/etc colors;
* Improved documentation for all customizations (pre-existing & new).

To use:

1. Use this folder as the `_themes` subdirectory of your Sphinx project (copy
   it, use a git submodule, whatever.)
2. Add to your `conf.py`:

    import os
    import sys

    sys.path.append(os.path.abspath('_themes'))
    html_theme_path = ['_themes']
    html_theme = 'flasky'

3. If desired, add one final option to `conf.py` overriding one or more theme
   options, like in this example:

      html_theme_options = {
          'logo': 'static/logo.png',
      }

   The available theme options are as follows:

   * `logo`: Relative path (from `$PROJECT/_themes/`) to a logo image, which
     will appear in the upper left corner above the name of the project.
{'fraction_non_alphanumeric': 0.0774243004982752, 'fraction_numerical': 0.0019164430816404753, 'mean_word_length': 3.9338374291115312, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '2029019', 'n_tokens_mistral': 798, 'n_tokens_neox': 748, 'n_words': 361}