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

This repository is a modified "Kr" Sphinx theme from @kennethreitz (especially
as used in his [Requests](https://python-requests.org) project), which was in
turn modfied from @mitsuhiko's theme used for [Flask](http://flask.pocoo.org/)
& 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.)
1. Enable the 'flasky' theme in your `conf.py`:

   ```python
   import os
   import sys
   
   sys.path.append(os.path.abspath('_themes'))
   html_theme_path = ['_themes']
   html_theme = 'flasky'
   html_sidebars = {
       'index': [
           'sidebar.html', 'sourcelink.html', 'searchbox.html'
       ],
       '**': [
           'sidebar.html', 'localtoc.html', 'relations.html',
           'sourcelink.html', 'searchbox.html'
       ]
   }
   ```

    * Modify the call to `abspath` if your `_themes` folder doesn't live right
    next to your `conf.py`.
    * Feel free to adjust `html_sidebars` as desired - the theme is designed
    assuming you'll have `sidebar.html` activated, but otherwise it doesn't
    care much.
        * See [the Sphinx
        docs](http://sphinx-doc.org/config.html#confval-html_sidebars) for
        details on how this setting behaves.
        * The theme ships with a modified (improved, sidebar & complex doctree
        friendly) `relations.html` as well, but does not require that you
        enable it.

1. If desired, add a final option to `conf.py` overriding one or more theme
   options, like in this example (*note*: snippet doesn't include all possible
   options, see following list!):

   ```python
   html_theme_options = {
       'logo': 'logo.png',
       'github_user': 'bitprophet',
       'github_repo': 'sphinx-theme',
   }
   ```

   The available theme options (which are all optional) are as follows:

   * `logo`: Relative path (from `$PROJECT/_static/`) to a logo image, which
   will appear in the upper left corner above the name of the project.
      * If `logo` is not set, your `project` name setting (from the top level
      Sphinx config) will be used in a text header instead. This preserves a<commit_msg>Update README re: required other conf.py option for static media<commit_after># Modified 'Kr/Flask' Sphinx theme

This repository is a modified "Kr" Sphinx theme from @kennethreitz (especially
as used in his [Requests](https://python-requests.org) project), which was in
turn modfied from @mitsuhiko's theme used for [Flask](http://flask.pocoo.org/)
& 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.)
1. Enable the 'flasky' theme in your `conf.py`:

   ```python
   import os
   import sys
   
   sys.path.append(os.path.abspath('_themes'))
   html_theme_path = ['_themes']
   html_theme = 'flasky'
   html_sidebars = {
       'index': [
           'sidebar.html', 'sourcelink.html', 'searchbox.html'
       ],
       '**': [
           'sidebar.html', 'localtoc.html', 'relations.html',
           'sourcelink.html', 'searchbox.html'
       ]
   }
   ```

    * Modify the call to `abspath` if your `_themes` folder doesn't live right
    next to your `conf.py`.
    * Feel free to adjust `html_sidebars` as desired - the theme is designed
    assuming you'll have `sidebar.html` activated, but otherwise it doesn't
    care much.
        * See [the Sphinx
        docs](http://sphinx-doc.org/config.html#confval-html_sidebars) for
        details on how this setting behaves.
        * The theme ships with a modified (improved, sidebar & complex doctree
        friendly) `relations.html` as well, but does not require that you
        enable it.

1. If you're using either of the image-related options outlined below (logo or
   touch-icon), you'll also want to tell Sphinx where to get your images from.
   If so, add a line like this (changing the path if necessary; see [the Sphinx
   docs](http://sphinx-doc.org/config.html?highlight=static#confval-html_static_path)):

   ```python
   html_static_path = ['_static']
   ```

1. Add one more section to `conf.py` setting one or more theme options, like in
   this example (*note*: snippet doesn't include all possible options, see
   following list!):

   ```python
   html_theme_options = {
       'logo': 'logo.png',
       'github_user': 'bitprophet',
       'github_repo': 'sphinx-theme',
   }
   ```

   The available theme options (which are all optional) are as follows:

   * `logo`: Relative path (from `$PROJECT/_static/`) to a logo image, which
   will appear in the upper left corner above the name of the project.
      * If `logo` is not set, your `project` name setting (from the top level
      Sphinx config) will be used in a text header instead. This preserves a
{'fraction_non_alphanumeric': 0.09816053511705686, 'fraction_numerical': 0.0011705685618729096, 'mean_word_length': 3.2569395017793594, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '6731610', 'n_tokens_mistral': 1827, 'n_tokens_neox': 1745, 'n_words': 727}