cylc_lang: add breadcrumb path to config sections (#74)

* cylc_lang: add "breadcrumb" path to config sections
* Closes #70
* Improve config reference style
* Update GH Actions test workflow
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>

.github/workflows/test.yml

@@ -1,23 +1,29 @@
 name: test
 
-on: [pull_request]
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    branches: [master]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     strategy:
       matrix:
-        python-version: ['3.7']
+        python-version: ['3.7', '3.9']
+    env:
+        PYTEST_ADDOPTS: --color=yes
     steps:
       - name: checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3
 
       - name: eslint
         run: npx eslint .
 
       - name: configure python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 

cylc/sphinx_ext/cylc_lang/autodocumenters.py

@@ -168,7 +168,7 @@ def doc_setting(item):
 
 
 def doc_section(item):
-    fields = {}
+    fields = {'Path': f'``{repr(item)}``'}
     if item.meta is True:
         # too meta for us
         # this is section inside a meta section

cylc/sphinx_ext/cylc_lang/tests/test_autodocumenters.py

@@ -194,6 +194,8 @@ def test_doc_section(simple_section):
     """It should docuement configuration sections."""
     assert doc_section(simple_section) == [
         '.. cylc:section:: simple-section',
+        '',
+        '   :Path: ``simple-section``',
         ''
     ]
 
@@ -251,6 +253,8 @@ def test_doc_spec(documented_spec):
         '',
         '   .. cylc:section:: documented-section',
         '',
+        '      :Path: ``documented-conf[documented-section]``',
+        '',
         '      d',
         '      e',
         '',

cylc/sphinx_ext/rtd_theme_addons/_static/css/addons.css

@@ -122,3 +122,8 @@ span.versionmodified{
     overflow-x: hidden!important;
     overflow-y: hidden!important;
 }
+
+/* Remove awkward margin for config reference "Path", "Type" etc. */
+.rst-content .cylc.conf .field-list {
+    margin-bottom: 0;
+}