[wip] Add Lighthouse in CI

.github/workflows/artifact.yml

@@ -4,8 +4,30 @@ jobs:
     runs-on: ubuntu-latest
     name: Run CircleCI artifacts redirector
     steps:
-      - name: GitHub Action step
-        uses: larsoner/circleci-artifacts-redirector-action@master
+      - name: Create URL for CircleCI artifact
+        id: redirect
+        # TODO: restore after https://github.com/larsoner/circleci-artifacts-redirector-action/pull/11
+        # uses: larsoner/circleci-artifacts-redirector-action@master
+        uses: bollwyvl/circleci-artifacts-redirector-action@add-url-output
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           artifact-path: 0/html/index.html
+      - name: Run Lighthouse on Site
+        id: lighthouse
+        uses: foo-software/lighthouse-check-action@master
+        with:
+          urls: ${{ steps.redirect.outputs.url }}
+          outputDirectory: /tmp/lighthouse
+      - name: Upload Lighthouse Reports
+        uses: actions/upload-artifact@master
+        with:
+          name: Lighthouse reports ${{ github.run_number }}
+          path: /tmp/artifacts
+      - name: Handle Lighthouse Check results
+        uses: foo-software/lighthouse-check-status-action@master
+        with:
+          lighthouseCheckResults: ${{ steps.lighthouse.outputs.lighthouseCheckResults }}
+          minAccessibilityScore: "98"
+          minBestPracticesScore: "53"
+          minPerformanceScore: "5"
+          minSeoScore: "93"

docs/conf.py

@@ -20,6 +20,7 @@
 project = "PyData Sphinx Theme"
 copyright = "2019, PyData Community"
 author = "PyData Community"
+language = "en"
 
 # The full version, including alpha/beta/rc tags
 release = "0.0.1dev0"

pydata_sphinx_theme/docs-sidebar.html

@@ -4,7 +4,7 @@
   {%- include "search-field.html" %}
 {% endif %}
 
-<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
+<nav class="bd-links" id="bd-docs-nav" role="navigation" aria-label="{{  _('Main navigation') }}">
 
   <div class="bd-toc-item active">
   {% set nav = get_nav_object(maxdepth=3, collapse=True) %}

pydata_sphinx_theme/docs-toc.html

@@ -6,7 +6,7 @@
 </div>
 {%- endif %}
 
-<nav id="bd-toc-nav">
+<nav id="bd-toc-nav" role="navigation" aria-label="{{  _('Table of Contents') }}">
     <ul class="nav section-nav flex-column">
     {% for item in page_toc recursive %}
         <li class="nav-item toc-entry toc-h{{ loop.depth + 1 }}">

pydata_sphinx_theme/layout.html

@@ -19,7 +19,9 @@
 
 {%- block extrahead %}
     <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta name="docsearch:language" content="en">
+    {% if language %}
+    <meta name="docsearch:language" content="{{ language }}">
+    {% endif %}
 {%- endblock %}
 
 {# Silence the sidebar's, relbar's #}
@@ -33,7 +35,7 @@
 {%- endblock %}
 {%- block content %}
     {% block docs_navbar %}
-    <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
+    <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"  role="navigation" aria-label="{{  _('Site navigation') }}">
       {%- include "docs-navbar.html" %}
     </nav>
     {% endblock %}
@@ -89,4 +91,4 @@
 
 {%- block footer %}
 {%- include "footer.html" %}
-{%- endblock %}
+{%- endblock %}