jmespath · springcomp · Feb 18, 2022 · Feb 18, 2022 · Feb 18, 2022 · Feb 18, 2022
diff --git a/.github/workflows/build-sphinx.yml b/.github/workflows/build-sphinx.yml
@@ -0,0 +1,57 @@
+name: build-sphinx-to-gh-pages
+
+env:
+ GITHUB_ACTOR: Springcomp
+ GITHUB_REPOSITORY: jmespath-unofficial/jmespath.site
+
+on:
+ push:
+ branches:
+ - master
+
+jobs:
+
+ build-sphinx-job:
+ runs-on: ubuntu-latest
+ container: debian:buster-slim
+
+ steps:
+ - name: 📚 checkout
+ uses: actions/checkout@v2
+
+ - name: install prerequisites
+ run: |
+ set -x
+ apt-get update
+ apt-get install -y \
+ git \
+ make \
+ python3-sphinx
+ shell: bash
+
+ - name: prepare GitHub pages
+ run: |
+ git init
+ git config --local user.name "${GITHUB_ACTOR}"
+ git config --local user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+ git remote add deploy "https://${GITHUB_ACTOR}:${GITHUB_PERSONAL_ACCESS_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" 
+ git checkout -b gh-pages
+ touch docs/.nojekyll
+ shell: bash
+ env:
+ GITHUB_PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+
+ - name: build Sphinx
+ run: |
+ make clean
+ make html
+ shell: bash
+
+ - name: publish GitHub pages
+ run: |
+ cp -r documentation/_build/html/* docs/
+ git add -f --all docs/*
+ git add -f docs/.nojekyll
+ git commit -am "[gh-pages] Publishing changes to GitHub pages"
+ git push deploy gh-pages --force
+ shell: bash
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
-docs/_build/*
+documentation/_build/
+docs/
 *.pyc
diff --git a/Makefile b/Makefile
@@ -2,20 +2,16 @@ help:
  @echo 'Makefile for a pelican Web site '
  @echo ' '
  @echo 'Usage: '
- @echo ' make publish upload to s3 bucket '
+ @echo ' make clean '
+ @echo ' make html '
 
 
-publish:
- $(MAKE) -C docs/ publish
-
 clean:
- $(MAKE) -C docs/ clean
+ $(MAKE) -C documentation/ clean
 
 html:
- $(MAKE) -C docs/ html
+ $(MAKE) -C documentation/ html
 
 doclint:
  find . -type f -name "*.rst" | xargs doc8
 
-
-.PHONY: help publish
diff --git a/docs/_themes/README → docs/.nojekyll b/docs/_themes/README → docs/.nojekyll
diff --git a/docs/Makefile → documentation/Makefile b/docs/Makefile → documentation/Makefile
diff --git a/docs/_static/html/jmespath_1col_demo.html → ...tion/_static/html/jmespath_1col_demo.html b/docs/_static/html/jmespath_1col_demo.html → ...tion/_static/html/jmespath_1col_demo.html
diff --git a/docs/_static/html/jmespath_2col_demo.html → ...tion/_static/html/jmespath_2col_demo.html b/docs/_static/html/jmespath_2col_demo.html → ...tion/_static/html/jmespath_2col_demo.html
diff --git a/...tatic/html/jmespath_2col_expand_demo.html → ...tatic/html/jmespath_2col_expand_demo.html b/...tatic/html/jmespath_2col_expand_demo.html → ...tatic/html/jmespath_2col_expand_demo.html
diff --git a/docs/_static/img/logo-dark.png → documentation/_static/img/logo-dark.png b/docs/_static/img/logo-dark.png → documentation/_static/img/logo-dark.png
diff --git a/docs/_static/img/logo.png → documentation/_static/img/logo.png b/docs/_static/img/logo.png → documentation/_static/img/logo.png
diff --git a/docs/_static/js/jmespath.min.js → documentation/_static/js/jmespath.min.js b/docs/_static/js/jmespath.min.js → documentation/_static/js/jmespath.min.js
diff --git a/docs/_templates/index.html → documentation/_templates/index.html b/docs/_templates/index.html → documentation/_templates/index.html
@@ -45,20 +45,20 @@ <h2>Try it Out!</h2>
  <p>The expression is evaluated against the JSON data and the result is
  shown in the result pane.</p>
  <p>To learn more about JMESPath, check out the
- <a href="{{ pathto('tutorial') }}">JMESPath Tutorial</a> and
- <a href="{{ pathto('examples') }}">JMESPath Examples</a>.
+ <a href="{{ pathto('tutorial.html', 1) }}">JMESPath Tutorial</a> and
+ <a href="{{ pathto('examples.html', 1) }}">JMESPath Examples</a>.
  <p>Have questions? Come <a href="https://gitter.im/jmespath/chat">chat with us</a>.</p>
  <p></p>
  <p></p>
- <a href="{{ pathto('tutorial') }}" class="btn btn-info btn-lg">JMESPath Tutorial</a>
+ <a href="{{ pathto('tutorial.html', 1) }}" class="btn btn-info btn-lg">JMESPath Tutorial</a>
  </div>
  </div>
  <div class="row">
  <div class="col-md-4">
  <h3 class="section-distinct">A Complete Specification</h3>
  <p>
  The JMESPath language is described in an
- <a href="{{ pathto('specification') }}">ABNF grammar</a> with a complete
+ <a href="{{ pathto('specification.html', 1) }}">ABNF grammar</a> with a complete
  specification. This ensures that the language syntax is precisely defined.
  </p>
  </div>
@@ -67,14 +67,14 @@ <h3 class="section-distinct">A compliance test suite</h3>
  <p>
  JMESPath has a full suite of data driven testcases. This ensures
  parity for multiple libraries, and makes it easy for developers to
- <a href="{{ pathto('compliance') }}">implement JMESPath</a> in their
+ <a href="{{ pathto('compliance.html', 1) }}">implement JMESPath</a> in their
  language of choice.
  </p>
  </div>
  <div class="col-md-4">
  <h3 class="section-distinct">Libraries in Multiple Languages</h3>
  <p>
- Each <a href="{{ pathto('libraries') }}">JMESPath library</a>
+ Each <a href="{{ pathto('libraries.html', 1) }}">JMESPath library</a>
  passes a complete suite of compliance tests to ensure they work as intended.
  There are libraries in multiple languages including python, php,
  javascript and lua.

diff --git a/docs/_templates/logo-sidebar.html → documentation/_templates/logo-sidebar.html b/docs/_templates/logo-sidebar.html → documentation/_templates/logo-sidebar.html
diff --git a/docs/_templates/mainlinks.html → documentation/_templates/mainlinks.html b/docs/_templates/mainlinks.html → documentation/_templates/mainlinks.html
diff --git a/docs/_templates/searchbox.html → documentation/_templates/searchbox.html b/docs/_templates/searchbox.html → documentation/_templates/searchbox.html
diff --git a/documentation/_themes/README b/documentation/_themes/README
diff --git a/docs/_themes/jmespath/.DS_Store → documentation/_themes/jmespath/.DS_Store b/docs/_themes/jmespath/.DS_Store → documentation/_themes/jmespath/.DS_Store
diff --git a/docs/_themes/jmespath/layout.html → documentation/_themes/jmespath/layout.html b/docs/_themes/jmespath/layout.html → documentation/_themes/jmespath/layout.html
@@ -111,11 +111,11 @@
  </div>
  <div class="collapse navbar-collapse" id="toggle-main-nav">
  <ul class="nav navbar-nav">
- <li><a href="/">Home</a></li>
- <li><a href="/tutorial.html">Tutorial</a></li>
- <li><a href="/examples.html">Examples</a></li>
- <li><a href="/specification.html">Specification</a></li>
- <li><a href="/libraries.html">Libraries</a></li>
+ <li><a href="{{ pathto('index.html', 1) }}">Home</a></li>
+ <li><a href="{{ pathto('tutorial.html', 1) }}">Tutorial</a></li>
+ <li><a href="{{ pathto('examples.html', 1) }}">Examples</a></li>
+ <li><a href="{{ pathto('specification.html', 1) }}">Specification</a></li>
+ <li><a href="{{ pathto('libraries.html', 1) }}">Libraries</a></li>
  <li><a href="https://github.com/jmespath">Github</a></li>
  </ul>
  </div>

diff --git a/...espath/static/css/bootstrap-theme.min.css → ...espath/static/css/bootstrap-theme.min.css b/...espath/static/css/bootstrap-theme.min.css → ...espath/static/css/bootstrap-theme.min.css
diff --git a/...mes/jmespath/static/css/bootstrap.min.css → ...mes/jmespath/static/css/bootstrap.min.css b/...mes/jmespath/static/css/bootstrap.min.css → ...mes/jmespath/static/css/bootstrap.min.css
diff --git a/...ic/fonts/glyphicons-halflings-regular.eot → ...ic/fonts/glyphicons-halflings-regular.eot b/...ic/fonts/glyphicons-halflings-regular.eot → ...ic/fonts/glyphicons-halflings-regular.eot
diff --git a/...ic/fonts/glyphicons-halflings-regular.svg → ...ic/fonts/glyphicons-halflings-regular.svg b/...ic/fonts/glyphicons-halflings-regular.svg → ...ic/fonts/glyphicons-halflings-regular.svg
diff --git a/...ic/fonts/glyphicons-halflings-regular.ttf → ...ic/fonts/glyphicons-halflings-regular.ttf b/...ic/fonts/glyphicons-halflings-regular.ttf → ...ic/fonts/glyphicons-halflings-regular.ttf
diff --git a/...c/fonts/glyphicons-halflings-regular.woff → ...c/fonts/glyphicons-halflings-regular.woff b/...c/fonts/glyphicons-halflings-regular.woff → ...c/fonts/glyphicons-halflings-regular.woff
diff --git a/docs/_themes/jmespath/static/jmespath.css → ...tion/_themes/jmespath/static/jmespath.css b/docs/_themes/jmespath/static/jmespath.css → ...tion/_themes/jmespath/static/jmespath.css
diff --git a/docs/_themes/jmespath/static/jquery.js → ...ntation/_themes/jmespath/static/jquery.js b/docs/_themes/jmespath/static/jquery.js → ...ntation/_themes/jmespath/static/jquery.js
diff --git a/docs/_themes/jmespath/static/js/bootstrap.js → ...n/_themes/jmespath/static/js/bootstrap.js b/docs/_themes/jmespath/static/js/bootstrap.js → ...n/_themes/jmespath/static/js/bootstrap.js
diff --git a/...hemes/jmespath/static/js/bootstrap.min.js → ...hemes/jmespath/static/js/bootstrap.min.js b/...hemes/jmespath/static/js/bootstrap.min.js → ...hemes/jmespath/static/js/bootstrap.min.js
diff --git a/...ath/static/js/jquery-migrate-1.2.1.min.js → ...ath/static/js/jquery-migrate-1.2.1.min.js b/...ath/static/js/jquery-migrate-1.2.1.min.js → ...ath/static/js/jquery-migrate-1.2.1.min.js
diff --git a/docs/_themes/jmespath/theme.conf → documentation/_themes/jmespath/theme.conf b/docs/_themes/jmespath/theme.conf → documentation/_themes/jmespath/theme.conf
diff --git a/docs/compliance.rst → documentation/compliance.rst b/docs/compliance.rst → documentation/compliance.rst
diff --git a/docs/conf.py → documentation/conf.py b/docs/conf.py → documentation/conf.py
diff --git a/docs/contents.rst → documentation/contents.rst b/docs/contents.rst → documentation/contents.rst
diff --git a/docs/examples.rst → documentation/examples.rst b/docs/examples.rst → documentation/examples.rst
diff --git a/docs/jpexample.py → documentation/jpexample.py b/docs/jpexample.py → documentation/jpexample.py
diff --git a/docs/libraries.rst → documentation/libraries.rst b/docs/libraries.rst → documentation/libraries.rst
diff --git a/docs/proposals.rst → documentation/proposals.rst b/docs/proposals.rst → documentation/proposals.rst
diff --git a/docs/proposals/array-slices.rst → documentation/proposals/array-slices.rst b/docs/proposals/array-slices.rst → documentation/proposals/array-slices.rst
diff --git a/docs/proposals/exptype.rst → documentation/proposals/exptype.rst b/docs/proposals/exptype.rst → documentation/proposals/exptype.rst
diff --git a/docs/proposals/filter-expressions.rst → ...entation/proposals/filter-expressions.rst b/docs/proposals/filter-expressions.rst → ...entation/proposals/filter-expressions.rst
diff --git a/docs/proposals/functions.rst → documentation/proposals/functions.rst b/docs/proposals/functions.rst → documentation/proposals/functions.rst
diff --git a/docs/proposals/improved-filters.rst → documentation/proposals/improved-filters.rst b/docs/proposals/improved-filters.rst → documentation/proposals/improved-filters.rst
diff --git a/docs/proposals/improved-identifiers.rst → ...tation/proposals/improved-identifiers.rst b/docs/proposals/improved-identifiers.rst → ...tation/proposals/improved-identifiers.rst
diff --git a/docs/proposals/nested-expressions.rst → ...entation/proposals/nested-expressions.rst b/docs/proposals/nested-expressions.rst → ...entation/proposals/nested-expressions.rst
diff --git a/docs/proposals/pipes.rst → documentation/proposals/pipes.rst b/docs/proposals/pipes.rst → documentation/proposals/pipes.rst
diff --git a/docs/proposals/raw-string-literals.rst → ...ntation/proposals/raw-string-literals.rst b/docs/proposals/raw-string-literals.rst → ...ntation/proposals/raw-string-literals.rst
diff --git a/docs/proposals/slice-projections.rst → ...mentation/proposals/slice-projections.rst b/docs/proposals/slice-projections.rst → ...mentation/proposals/slice-projections.rst
diff --git a/docs/sitemap.py → documentation/sitemap.py b/docs/sitemap.py → documentation/sitemap.py
diff --git a/docs/specification.rst → documentation/specification.rst b/docs/specification.rst → documentation/specification.rst
diff --git a/docs/tutorial.rst → documentation/tutorial.rst b/docs/tutorial.rst → documentation/tutorial.rst