Make linters happy

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation.md

@@ -1,10 +1,9 @@
 ---
 name: Documentation
 about: Report missing or inaccurate content in the documentation
-title: ''
+title: ""
 labels: documentation
-assignees: ''
-
+assignees: ""
 ---
 
 **URL**: [The URL at which the content is missing or inaccurate]

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
+title: ""
 labels: enhancement
-assignees: ''
-
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/workflows/deploy.yml

@@ -8,19 +8,19 @@ jobs:
     name: Documentation
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
 
-    - name: Install dependencies
-      run: |
-        pip install nox
-        npm install
+      - name: Install dependencies
+        run: |
+          pip install nox
+          npm install
 
-    - name: Generate documentation
-      run: nox -s docs
+      - name: Generate documentation
+        run: nox -s docs
 
-    - name: Upload to GitHub Pages
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./build/docs/
+      - name: Upload to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build/docs/

docs/_templates/layouts/home.html

@@ -1,6 +1,3 @@
-This page has to be worked on.
-
-This will eventually become a nice preview of the theme, with a slider/carosel-like
-show with multiple customisations of the same.
-
+This page has to be worked on. This will eventually become a nice preview of the
+theme, with a slider/carosel-like show with multiple customisations of the same.
 For now, tho, just look at the next page: <a href="{{ next.link }}">{{ next.title }}</a>

docs/changelog.md

@@ -9,12 +9,12 @@ hide-toc: true
 - Add CSS variables for header foreground and background.
 - Add styling for captions.
 - Add styling for correctly handling permalinks.
-- Correctly stylize *only* definition lists with the rules intended for them.
+- Correctly stylize _only_ definition lists with the rules intended for them.
 - Fix next/prev links flowing into one-another by limiting width to 50%.
 - Fix positioning of collapsed contents sidebar icon.
 - Fix shrinking arrows in next/prev links.
-- Include ``basic`` theme's JS files unconditionally. This should help with compatibility with various Sphinx extensions and ReadTheDocs.
-- Make ``math`` elements scrollable, when wider than the page.
+- Include `basic` theme's JS files unconditionally. This should help with compatibility with various Sphinx extensions and ReadTheDocs.
+- Make `math` elements scrollable, when wider than the page.
 - Tweak images to be responsive.
 - Tweak spacing of paragraphs.
 - Tweak location of ReadTheDocs' injected version helper.

docs/conf.py

@@ -25,7 +25,12 @@
 # -- General configuration ---------------------------------------------------
 #
 
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.mathjax", "sphinx.ext.todo", "myst_parser"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.todo",
+    "myst_parser",
+]
 templates_path = ["_templates"]
 
 #
@@ -52,5 +57,5 @@
     "sidebar_hide_name": True,
     "announcement": (
         "Furo is under active development, and this documentation is not written yet!"
-    )
+    ),
 }

docs/customisation/index.md

@@ -12,7 +12,6 @@ furo can be customized in many ways.
   - the sidebar's contents
   - selectively hide UI elements/TOC on a certain pages
 
-
 ```{toctree}
 :caption: Reference for various elements
 :maxdepth: 1
@@ -24,7 +23,6 @@ toc-sidebar
 admonitions
 ```
 
-
 ## Theme options
 
 furo utilizes [`html_theme_options`][sphinx-html-theme-options] key in `conf.py` for customization of the overall theme.
@@ -41,10 +39,7 @@ furo's stylesheet makes extensive use of [CSS variables][css-variables]. It is p
 
 ```python
 html_theme_options = {
-  "css_variables": {
-    "color-brand-primary": "red",
-    "color-brand-content": "#CC3333",
-  }
+    "css_variables": {"color-brand-primary": "red", "color-brand-content": "#CC3333",}
 }
 ```
 
@@ -58,7 +53,7 @@ Controls whether you see the project's name in the sidebar of the documentation.
 
 ```python
 html_theme_options = {
-  "sidebar_hide_name": True,
+    "sidebar_hide_name": True,
 }
 ```
 
@@ -90,6 +85,7 @@ Markdown:
 ---
 hide-toc: true
 ---
+
 ```
 
 reST:

src/furo/assets/styles/_layout.scss

@@ -12,7 +12,8 @@
 body {
   overflow-y: scroll; // always have the scrollbar
 }
-html, body {
+html,
+body {
   height: 100%;
 }
 .page {
@@ -106,7 +107,8 @@ header {
 }
 .announcement + .page {
   min-height: calc(100% - var(--header-height));
-  .sidebar-scroll, .toc-scroll {
+  .sidebar-scroll,
+  .toc-scroll {
     max-height: calc(100vh - var(--header-height));
   }
 }

src/furo/assets/styles/_typography.scss

@@ -74,7 +74,6 @@ p {
   margin-bottom: 0.75em;
 }
 
-
 // Horizontal rules
 hr.docutils {
   height: 0.0625rem;

src/furo/assets/styles/_variables.scss

@@ -133,7 +133,7 @@ $admonitions: (
   --color-background-border: #eeebee;
 
   // Announcements
-  --color-announcement-background: #000000DD;
+  --color-announcement-background: #000000dd;
   --color-announcement-text: #eeebee;
 
   // Brand colors

src/furo/assets/styles/content/_block_elements.scss

@@ -124,7 +124,10 @@ pre {
   }
 }
 
-.field-list, .option-list, dl.myst, dl.footnote {
+.field-list,
+.option-list,
+dl.myst,
+dl.footnote {
   dt {
     display: inline-block;
     margin-top: 0.25rem;

src/furo/assets/styles/content/_inline_elements.scss

@@ -39,7 +39,16 @@ code.literal {
 // Permalinks
 //    Adapted from Sphinx-RTD-theme's corresponding CSS
 //    https://github.com/readthedocs/sphinx_rtd_theme/blob/1a32899b/src/sass/_theme_rst.sass#L201
-h1, h2, h3, h4, h5, h6, dl dt, p.caption, table > caption, .code-block-caption {
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+dl dt,
+p.caption,
+table > caption,
+.code-block-caption {
   > .headerlink {
     font-weight: 100;
     margin-left: 0.5rem;
@@ -51,7 +60,9 @@ h1, h2, h3, h4, h5, h6, dl dt, p.caption, table > caption, .code-block-caption {
 }
 
 // Captions
-article p.caption, table > caption, .code-block-caption {
+article p.caption,
+table > caption,
+.code-block-caption {
   font-size: var(--font-size--small);
   text-align: center;
 }