Updated GitHub Actions workflows and docs.

domdfcoding · domdfcoding · commit e60f5704fe4c · 2021-01-11T11:04:59.000Z
diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: ['windows-2019', 'macos-latest', 'ubuntu-20.04']
       fail-fast: false
 
     steps:
diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: "windows-2019"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.3'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.4'
 
     strategy:
       fail-fast: False
@@ -23,7 +23,7 @@ jobs:
           - {python-version: "3.7", testenvs: "py37,build", experimental: False}
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.10.0-alpha.4", testenvs: "py310-dev,build", experimental: True}
 
     steps:
       - name: Checkout 🛎️
diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: "ubuntu-20.04"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.3,pypy-3.6'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.4,pypy-3.6'
 
     strategy:
       fail-fast: False
@@ -23,7 +23,7 @@ jobs:
           - {python-version: "3.7", testenvs: "py37,build", experimental: False}
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.10.0-alpha.4", testenvs: "py310-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy3,build", experimental: False}
 
     steps:
diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: "macos-latest"
     continue-on-error: ${{ matrix.config.experimental }}
     env:
-      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.3,pypy-3.6'
+      USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10.0-alpha.4,pypy-3.6'
 
     strategy:
       fail-fast: False
@@ -23,7 +23,7 @@ jobs:
           - {python-version: "3.7", testenvs: "py37,build", experimental: False}
           - {python-version: "3.8", testenvs: "py38,build", experimental: False}
           - {python-version: "3.9", testenvs: "py39,build", experimental: False}
-          - {python-version: "3.10.0-alpha.3", testenvs: "py310-dev,build", experimental: True}
+          - {python-version: "3.10.0-alpha.4", testenvs: "py310-dev,build", experimental: True}
           - {python-version: "pypy-3.6", testenvs: "pypy3,build", experimental: False}
 
     steps:
diff --git a/.pylintrc b/.pylintrc
@@ -66,7 +66,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 disable=all
-enable=assert-on-tuple,astroid-error,bad-except-order,bad-inline-option,bad-option-value,bad-reversed-sequence,bare-except,binary-op-exception,boolean-datetime,catching-non-exception,cell-var-from-loop,confusing-with-statement,consider-merging-isinstance,consider-using-enumerate,consider-using-ternary,continue-in-finally,cyclic-import,deprecated-pragma,django-not-available,duplicate-except,duplicate-key,eval-used,exec-used,expression-not-assigned,fatal,file-ignored,fixme,global-at-module-level,global-statement,global-variable-not-assigned,global-variable-undefined,http-response-with-content-type-json,http-response-with-json-dumps,invalid-all-object,invalid-characters-in-docstring,len-as-condition,literal-comparison,locally-disabled,locally-enabled,lost-exception,lowercase-l-suffix,misplaced-bare-raise,missing-kwoa,mixed-line-endings,model-has-unicode,model-missing-unicode,model-no-explicit-unicode,model-unicode-not-callable,multiple-imports,multiple-statements,new-db-field-with-default,non-ascii-bytes-literals,nonexistent-operator,not-an-iterable,not-in-loop,notimplemented-raised,overlapping-except,parse-error,pointless-statement,pointless-string-statement,raising-bad-type,raising-non-exception,raw-checker-failed,redefine-in-handler,redefined-argument-from-local,redefined-builtin,redundant-content-type-for-json-response,reimported,relative-import,return-outside-function,simplifiable-if-statement,singleton-comparison,syntax-error,trailing-comma-tuple,trailing-newlines,unbalanced-tuple-unpacking,undefined-all-variable,undefined-loop-variable,unexpected-line-ending-format,unidiomatic-typecheck,unnecessary-lambda,unnecessary-pass,unnecessary-semicolon,unneeded-not,unpacking-non-sequence,unreachable,unrecognized-inline-option,used-before-assignment,useless-else-on-loop,using-constant-test,wildcard-import,yield-outside-function,useless-return
+enable=assert-on-tuple,astroid-error,bad-except-order,bad-inline-option,bad-option-value,bad-reversed-sequence,bare-except,binary-op-exception,boolean-datetime,catching-non-exception,cell-var-from-loop,confusing-with-statement,consider-merging-isinstance,consider-using-enumerate,consider-using-ternary,continue-in-finally,cyclic-import,deprecated-pragma,django-not-available,duplicate-except,duplicate-key,eval-used,exec-used,expression-not-assigned,fatal,file-ignored,fixme,global-at-module-level,global-statement,global-variable-not-assigned,global-variable-undefined,http-response-with-content-type-json,http-response-with-json-dumps,invalid-all-object,invalid-characters-in-docstring,len-as-condition,literal-comparison,locally-disabled,locally-enabled,lost-exception,lowercase-l-suffix,misplaced-bare-raise,missing-kwoa,mixed-line-endings,model-has-unicode,model-missing-unicode,model-no-explicit-unicode,model-unicode-not-callable,multiple-imports,multiple-statements,new-db-field-with-default,non-ascii-bytes-literals,nonexistent-operator,not-in-loop,notimplemented-raised,overlapping-except,parse-error,pointless-statement,pointless-string-statement,raising-bad-type,raising-non-exception,raw-checker-failed,redefine-in-handler,redefined-argument-from-local,redefined-builtin,redundant-content-type-for-json-response,reimported,relative-import,return-outside-function,simplifiable-if-statement,singleton-comparison,syntax-error,trailing-comma-tuple,trailing-newlines,unbalanced-tuple-unpacking,undefined-all-variable,undefined-loop-variable,unexpected-line-ending-format,unidiomatic-typecheck,unnecessary-lambda,unnecessary-pass,unnecessary-semicolon,unneeded-not,unpacking-non-sequence,unreachable,unrecognized-inline-option,used-before-assignment,useless-else-on-loop,using-constant-test,wildcard-import,yield-outside-function,useless-return
 
 [REPORTS]
 
diff --git a/doc-source/_static/style.css b/doc-source/_static/style.css
@@ -0,0 +1,6 @@
+/* This file is managed by 'repo_helper'. Don't edit it directly. */
+
+div.highlight {
+    -moz-tab-size: 4; /* Firefox */
+    tab-size: 4;
+}
diff --git a/doc-source/_templates/base.html b/doc-source/_templates/base.html
@@ -1,5 +1,5 @@
 <!--- This file is managed by 'repo_helper'. Don't edit it directly. --->
-{% extends "!layout.html" %}
+{% extends "!base.html" %}
 {% block extrahead %}
 	<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
 {% endblock %}
diff --git a/doc-source/_templates/sidebar/navigation.html b/doc-source/_templates/sidebar/navigation.html
@@ -0,0 +1,12 @@
+<!---This file is managed by 'repo_helper'. Don't edit it directly.--->
+<div class="sidebar-tree">
+  {{ furo_navigation_tree }}
+</div>
+
+<div class="sidebar-tree">
+  <p class="caption"><span class="caption-text">Links</span></p>
+  <ul>
+    <li class="toctree-l1"><a class="reference external" href="https://github.com/domdfcoding/flake8_strftime">GitHub</a></li>
+    <li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/flake8_strftime">PyPI</a></li>
+  </ul>
+</div>
diff --git a/doc-source/api.rst b/doc-source/api.rst
@@ -0,0 +1,8 @@
+================
+API Reference
+================
+
+.. automodule:: flake8_strftime
+	:private-members:
+	:special-members:
+	:undoc-members:
diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -66,18 +66,23 @@
 		"sphinx": ("https://www.sphinx-doc.org/en/stable/", None),
 		}
 
-html_theme = "domdf_sphinx_theme"
-html_theme_options = {"logo_only": False}
+html_theme = "furo"
+html_theme_options = {
+		"light_css_variables": {
+				"toc-title-font-size": "12pt",
+				"toc-font-size": "12pt",
+				"admonition-font-size": "12pt",
+				},
+		"dark_css_variables": {
+				"toc-title-font-size": "12pt",
+				"toc-font-size": "12pt",
+				"admonition-font-size": "12pt",
+				},
+		}
 html_theme_path = ["../.."]
 html_show_sourcelink = True  # True will show link to source
 
-html_context = {
-		"display_github": True,
-		"github_user": "domdfcoding",
-		"github_repo": "flake8_strftime",
-		"github_version": "master",
-		"conf_py_path": "/doc-source/",
-		}
+html_context = {}
 htmlhelp_basename = slug
 
 latex_documents = [("index", f'{slug}.tex', project, author, "manual")]
diff --git a/doc-source/contributing.rst b/doc-source/contributing.rst
@@ -1,5 +1,6 @@
-Overview
----------
+==============
+Contributing
+==============
 
 .. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
 
diff --git a/doc-source/docs.rst b/doc-source/docs.rst
diff --git a/doc-source/index.rst b/doc-source/index.rst
@@ -157,13 +157,7 @@ Sample ``.pre-commit-config.yaml``:
 	:caption: Documentation
 
 	codes
-	API Reference<docs>
-
-
-.. toctree::
-	:maxdepth: 3
-	:caption: Contributing
-
+	api
 	contributing
 	Source
 
diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt
@@ -1,7 +1,7 @@
 autodocsumm>=0.2.0
 default-values>=0.4.2
-domdf-sphinx-theme>=0.3.0
 extras-require>=0.2.0
+furo>=2020.11.19b18
 pyyaml>=5.3.1
 repo-helper-sphinx-theme>=0.0.2
 seed-intersphinx-mapping>=0.3.1
diff --git a/repo_helper.yml b/repo_helper.yml
@@ -22,7 +22,6 @@ python_versions:
  - "3.10-dev"
  - "pypy3"
 
-# travis secure password for PyPI
 
 classifiers:
  - 'Development Status :: 4 - Beta'
@@ -37,3 +36,6 @@ extra_sphinx_extensions:
 entry_points:
   flake8.extension:
    - STRFTIME=flake8_strftime:Plugin
+
+sphinx_html_theme: furo
+standalone_contrib_guide: true
diff --git a/tox.ini b/tox.ini
@@ -86,7 +86,6 @@ ignore_errors = True
 changedir = {toxinidir}
 deps =
     mypy==0.790
-    lxml
     -r{toxinidir}/tests/requirements.txt
 commands = mypy flake8_strftime tests {posargs}
 
