From eae68fc7a00c723b05dfc1b46eb9ab8ef0ab2002 Mon Sep 17 00:00:00 2001 From: Maxime Labelle Date: Fri, 18 Feb 2022 13:57:38 +0100 Subject: [PATCH 1/4] [gh-pages] Renamed docs/ to documentation/ for sources. # Conflicts: # .gitignore --- .gitignore | 3 ++- Makefile | 12 ++++-------- {docs => documentation}/Makefile | 0 .../_static/html/jmespath_1col_demo.html | 0 .../_static/html/jmespath_2col_demo.html | 0 .../_static/html/jmespath_2col_expand_demo.html | 0 {docs => documentation}/_static/img/logo-dark.png | Bin {docs => documentation}/_static/img/logo.png | Bin {docs => documentation}/_static/js/jmespath.min.js | 0 {docs => documentation}/_templates/index.html | 0 .../_templates/logo-sidebar.html | 0 {docs => documentation}/_templates/mainlinks.html | 0 {docs => documentation}/_templates/searchbox.html | 0 {docs => documentation}/_themes/README | 0 {docs => documentation}/_themes/jmespath/.DS_Store | Bin .../_themes/jmespath/layout.html | 0 .../jmespath/static/css/bootstrap-theme.min.css | 0 .../_themes/jmespath/static/css/bootstrap.min.css | 0 .../static/fonts/glyphicons-halflings-regular.eot | Bin .../static/fonts/glyphicons-halflings-regular.svg | 0 .../static/fonts/glyphicons-halflings-regular.ttf | Bin .../static/fonts/glyphicons-halflings-regular.woff | Bin .../_themes/jmespath/static/jmespath.css | 0 .../_themes/jmespath/static/jquery.js | 0 .../_themes/jmespath/static/js/bootstrap.js | 0 .../_themes/jmespath/static/js/bootstrap.min.js | 0 .../jmespath/static/js/jquery-migrate-1.2.1.min.js | 0 {docs => documentation}/_themes/jmespath/theme.conf | 0 {docs => documentation}/compliance.rst | 0 {docs => documentation}/conf.py | 0 {docs => documentation}/contents.rst | 0 {docs => documentation}/examples.rst | 0 {docs => documentation}/jpexample.py | 0 {docs => documentation}/libraries.rst | 0 {docs => documentation}/proposals.rst | 0 {docs => documentation}/proposals/array-slices.rst | 0 {docs => documentation}/proposals/exptype.rst | 0 .../proposals/filter-expressions.rst | 0 {docs => documentation}/proposals/functions.rst | 0 .../proposals/improved-filters.rst | 0 .../proposals/improved-identifiers.rst | 0 .../proposals/nested-expressions.rst | 0 {docs => documentation}/proposals/pipes.rst | 0 .../proposals/raw-string-literals.rst | 0 .../proposals/slice-projections.rst | 0 {docs => documentation}/sitemap.py | 0 {docs => documentation}/specification.rst | 0 {docs => documentation}/tutorial.rst | 0 48 files changed, 6 insertions(+), 9 deletions(-) rename {docs => documentation}/Makefile (100%) rename {docs => documentation}/_static/html/jmespath_1col_demo.html (100%) rename {docs => documentation}/_static/html/jmespath_2col_demo.html (100%) rename {docs => documentation}/_static/html/jmespath_2col_expand_demo.html (100%) rename {docs => documentation}/_static/img/logo-dark.png (100%) rename {docs => documentation}/_static/img/logo.png (100%) rename {docs => documentation}/_static/js/jmespath.min.js (100%) rename {docs => documentation}/_templates/index.html (100%) rename {docs => documentation}/_templates/logo-sidebar.html (100%) rename {docs => documentation}/_templates/mainlinks.html (100%) rename {docs => documentation}/_templates/searchbox.html (100%) rename {docs => documentation}/_themes/README (100%) rename {docs => documentation}/_themes/jmespath/.DS_Store (100%) rename {docs => documentation}/_themes/jmespath/layout.html (100%) rename {docs => documentation}/_themes/jmespath/static/css/bootstrap-theme.min.css (100%) mode change 100755 => 100644 rename {docs => documentation}/_themes/jmespath/static/css/bootstrap.min.css (100%) mode change 100755 => 100644 rename {docs => documentation}/_themes/jmespath/static/fonts/glyphicons-halflings-regular.eot (100%) mode change 100755 => 100644 rename {docs => documentation}/_themes/jmespath/static/fonts/glyphicons-halflings-regular.svg (100%) mode change 100755 => 100644 rename {docs => documentation}/_themes/jmespath/static/fonts/glyphicons-halflings-regular.ttf (100%) mode change 100755 => 100644 rename {docs => documentation}/_themes/jmespath/static/fonts/glyphicons-halflings-regular.woff (100%) mode change 100755 => 100644 rename {docs => documentation}/_themes/jmespath/static/jmespath.css (100%) rename {docs => documentation}/_themes/jmespath/static/jquery.js (100%) rename {docs => documentation}/_themes/jmespath/static/js/bootstrap.js (100%) rename {docs => documentation}/_themes/jmespath/static/js/bootstrap.min.js (100%) mode change 100755 => 100644 rename {docs => documentation}/_themes/jmespath/static/js/jquery-migrate-1.2.1.min.js (100%) rename {docs => documentation}/_themes/jmespath/theme.conf (100%) rename {docs => documentation}/compliance.rst (100%) rename {docs => documentation}/conf.py (100%) rename {docs => documentation}/contents.rst (100%) rename {docs => documentation}/examples.rst (100%) rename {docs => documentation}/jpexample.py (100%) rename {docs => documentation}/libraries.rst (100%) rename {docs => documentation}/proposals.rst (100%) rename {docs => documentation}/proposals/array-slices.rst (100%) rename {docs => documentation}/proposals/exptype.rst (100%) rename {docs => documentation}/proposals/filter-expressions.rst (100%) rename {docs => documentation}/proposals/functions.rst (100%) rename {docs => documentation}/proposals/improved-filters.rst (100%) rename {docs => documentation}/proposals/improved-identifiers.rst (100%) rename {docs => documentation}/proposals/nested-expressions.rst (100%) rename {docs => documentation}/proposals/pipes.rst (100%) rename {docs => documentation}/proposals/raw-string-literals.rst (100%) rename {docs => documentation}/proposals/slice-projections.rst (100%) rename {docs => documentation}/sitemap.py (100%) rename {docs => documentation}/specification.rst (100%) rename {docs => documentation}/tutorial.rst (100%) diff --git a/.gitignore b/.gitignore index 17a6dd7..47c20d8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ -docs/_build/* +documentation/_build/ +docs/ *.pyc diff --git a/Makefile b/Makefile index bee0cc2..b3009de 100644 --- 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/Makefile b/documentation/Makefile similarity index 100% rename from docs/Makefile rename to documentation/Makefile diff --git a/docs/_static/html/jmespath_1col_demo.html b/documentation/_static/html/jmespath_1col_demo.html similarity index 100% rename from docs/_static/html/jmespath_1col_demo.html rename to documentation/_static/html/jmespath_1col_demo.html diff --git a/docs/_static/html/jmespath_2col_demo.html b/documentation/_static/html/jmespath_2col_demo.html similarity index 100% rename from docs/_static/html/jmespath_2col_demo.html rename to documentation/_static/html/jmespath_2col_demo.html diff --git a/docs/_static/html/jmespath_2col_expand_demo.html b/documentation/_static/html/jmespath_2col_expand_demo.html similarity index 100% rename from docs/_static/html/jmespath_2col_expand_demo.html rename to documentation/_static/html/jmespath_2col_expand_demo.html diff --git a/docs/_static/img/logo-dark.png b/documentation/_static/img/logo-dark.png similarity index 100% rename from docs/_static/img/logo-dark.png rename to documentation/_static/img/logo-dark.png diff --git a/docs/_static/img/logo.png b/documentation/_static/img/logo.png similarity index 100% rename from docs/_static/img/logo.png rename to documentation/_static/img/logo.png diff --git a/docs/_static/js/jmespath.min.js b/documentation/_static/js/jmespath.min.js similarity index 100% rename from docs/_static/js/jmespath.min.js rename to documentation/_static/js/jmespath.min.js diff --git a/docs/_templates/index.html b/documentation/_templates/index.html similarity index 100% rename from docs/_templates/index.html rename to documentation/_templates/index.html diff --git a/docs/_templates/logo-sidebar.html b/documentation/_templates/logo-sidebar.html similarity index 100% rename from docs/_templates/logo-sidebar.html rename to documentation/_templates/logo-sidebar.html diff --git a/docs/_templates/mainlinks.html b/documentation/_templates/mainlinks.html similarity index 100% rename from docs/_templates/mainlinks.html rename to documentation/_templates/mainlinks.html diff --git a/docs/_templates/searchbox.html b/documentation/_templates/searchbox.html similarity index 100% rename from docs/_templates/searchbox.html rename to documentation/_templates/searchbox.html diff --git a/docs/_themes/README b/documentation/_themes/README similarity index 100% rename from docs/_themes/README rename to documentation/_themes/README diff --git a/docs/_themes/jmespath/.DS_Store b/documentation/_themes/jmespath/.DS_Store similarity index 100% rename from docs/_themes/jmespath/.DS_Store rename to documentation/_themes/jmespath/.DS_Store diff --git a/docs/_themes/jmespath/layout.html b/documentation/_themes/jmespath/layout.html similarity index 100% rename from docs/_themes/jmespath/layout.html rename to documentation/_themes/jmespath/layout.html diff --git a/docs/_themes/jmespath/static/css/bootstrap-theme.min.css b/documentation/_themes/jmespath/static/css/bootstrap-theme.min.css old mode 100755 new mode 100644 similarity index 100% rename from docs/_themes/jmespath/static/css/bootstrap-theme.min.css rename to documentation/_themes/jmespath/static/css/bootstrap-theme.min.css diff --git a/docs/_themes/jmespath/static/css/bootstrap.min.css b/documentation/_themes/jmespath/static/css/bootstrap.min.css old mode 100755 new mode 100644 similarity index 100% rename from docs/_themes/jmespath/static/css/bootstrap.min.css rename to documentation/_themes/jmespath/static/css/bootstrap.min.css diff --git a/docs/_themes/jmespath/static/fonts/glyphicons-halflings-regular.eot b/documentation/_themes/jmespath/static/fonts/glyphicons-halflings-regular.eot old mode 100755 new mode 100644 similarity index 100% rename from docs/_themes/jmespath/static/fonts/glyphicons-halflings-regular.eot rename to documentation/_themes/jmespath/static/fonts/glyphicons-halflings-regular.eot diff --git a/docs/_themes/jmespath/static/fonts/glyphicons-halflings-regular.svg b/documentation/_themes/jmespath/static/fonts/glyphicons-halflings-regular.svg old mode 100755 new mode 100644 similarity index 100% rename from docs/_themes/jmespath/static/fonts/glyphicons-halflings-regular.svg rename to documentation/_themes/jmespath/static/fonts/glyphicons-halflings-regular.svg diff --git a/docs/_themes/jmespath/static/fonts/glyphicons-halflings-regular.ttf b/documentation/_themes/jmespath/static/fonts/glyphicons-halflings-regular.ttf old mode 100755 new mode 100644 similarity index 100% rename from docs/_themes/jmespath/static/fonts/glyphicons-halflings-regular.ttf rename to documentation/_themes/jmespath/static/fonts/glyphicons-halflings-regular.ttf diff --git a/docs/_themes/jmespath/static/fonts/glyphicons-halflings-regular.woff b/documentation/_themes/jmespath/static/fonts/glyphicons-halflings-regular.woff old mode 100755 new mode 100644 similarity index 100% rename from docs/_themes/jmespath/static/fonts/glyphicons-halflings-regular.woff rename to documentation/_themes/jmespath/static/fonts/glyphicons-halflings-regular.woff diff --git a/docs/_themes/jmespath/static/jmespath.css b/documentation/_themes/jmespath/static/jmespath.css similarity index 100% rename from docs/_themes/jmespath/static/jmespath.css rename to documentation/_themes/jmespath/static/jmespath.css diff --git a/docs/_themes/jmespath/static/jquery.js b/documentation/_themes/jmespath/static/jquery.js similarity index 100% rename from docs/_themes/jmespath/static/jquery.js rename to documentation/_themes/jmespath/static/jquery.js diff --git a/docs/_themes/jmespath/static/js/bootstrap.js b/documentation/_themes/jmespath/static/js/bootstrap.js similarity index 100% rename from docs/_themes/jmespath/static/js/bootstrap.js rename to documentation/_themes/jmespath/static/js/bootstrap.js diff --git a/docs/_themes/jmespath/static/js/bootstrap.min.js b/documentation/_themes/jmespath/static/js/bootstrap.min.js old mode 100755 new mode 100644 similarity index 100% rename from docs/_themes/jmespath/static/js/bootstrap.min.js rename to documentation/_themes/jmespath/static/js/bootstrap.min.js diff --git a/docs/_themes/jmespath/static/js/jquery-migrate-1.2.1.min.js b/documentation/_themes/jmespath/static/js/jquery-migrate-1.2.1.min.js similarity index 100% rename from docs/_themes/jmespath/static/js/jquery-migrate-1.2.1.min.js rename to documentation/_themes/jmespath/static/js/jquery-migrate-1.2.1.min.js diff --git a/docs/_themes/jmespath/theme.conf b/documentation/_themes/jmespath/theme.conf similarity index 100% rename from docs/_themes/jmespath/theme.conf rename to documentation/_themes/jmespath/theme.conf diff --git a/docs/compliance.rst b/documentation/compliance.rst similarity index 100% rename from docs/compliance.rst rename to documentation/compliance.rst diff --git a/docs/conf.py b/documentation/conf.py similarity index 100% rename from docs/conf.py rename to documentation/conf.py diff --git a/docs/contents.rst b/documentation/contents.rst similarity index 100% rename from docs/contents.rst rename to documentation/contents.rst diff --git a/docs/examples.rst b/documentation/examples.rst similarity index 100% rename from docs/examples.rst rename to documentation/examples.rst diff --git a/docs/jpexample.py b/documentation/jpexample.py similarity index 100% rename from docs/jpexample.py rename to documentation/jpexample.py diff --git a/docs/libraries.rst b/documentation/libraries.rst similarity index 100% rename from docs/libraries.rst rename to documentation/libraries.rst diff --git a/docs/proposals.rst b/documentation/proposals.rst similarity index 100% rename from docs/proposals.rst rename to documentation/proposals.rst diff --git a/docs/proposals/array-slices.rst b/documentation/proposals/array-slices.rst similarity index 100% rename from docs/proposals/array-slices.rst rename to documentation/proposals/array-slices.rst diff --git a/docs/proposals/exptype.rst b/documentation/proposals/exptype.rst similarity index 100% rename from docs/proposals/exptype.rst rename to documentation/proposals/exptype.rst diff --git a/docs/proposals/filter-expressions.rst b/documentation/proposals/filter-expressions.rst similarity index 100% rename from docs/proposals/filter-expressions.rst rename to documentation/proposals/filter-expressions.rst diff --git a/docs/proposals/functions.rst b/documentation/proposals/functions.rst similarity index 100% rename from docs/proposals/functions.rst rename to documentation/proposals/functions.rst diff --git a/docs/proposals/improved-filters.rst b/documentation/proposals/improved-filters.rst similarity index 100% rename from docs/proposals/improved-filters.rst rename to documentation/proposals/improved-filters.rst diff --git a/docs/proposals/improved-identifiers.rst b/documentation/proposals/improved-identifiers.rst similarity index 100% rename from docs/proposals/improved-identifiers.rst rename to documentation/proposals/improved-identifiers.rst diff --git a/docs/proposals/nested-expressions.rst b/documentation/proposals/nested-expressions.rst similarity index 100% rename from docs/proposals/nested-expressions.rst rename to documentation/proposals/nested-expressions.rst diff --git a/docs/proposals/pipes.rst b/documentation/proposals/pipes.rst similarity index 100% rename from docs/proposals/pipes.rst rename to documentation/proposals/pipes.rst diff --git a/docs/proposals/raw-string-literals.rst b/documentation/proposals/raw-string-literals.rst similarity index 100% rename from docs/proposals/raw-string-literals.rst rename to documentation/proposals/raw-string-literals.rst diff --git a/docs/proposals/slice-projections.rst b/documentation/proposals/slice-projections.rst similarity index 100% rename from docs/proposals/slice-projections.rst rename to documentation/proposals/slice-projections.rst diff --git a/docs/sitemap.py b/documentation/sitemap.py similarity index 100% rename from docs/sitemap.py rename to documentation/sitemap.py diff --git a/docs/specification.rst b/documentation/specification.rst similarity index 100% rename from docs/specification.rst rename to documentation/specification.rst diff --git a/docs/tutorial.rst b/documentation/tutorial.rst similarity index 100% rename from docs/tutorial.rst rename to documentation/tutorial.rst From c490a4c9743c5bc4a2020025f4a98a9d0d5f03c0 Mon Sep 17 00:00:00 2001 From: Maxime Labelle Date: Fri, 18 Feb 2022 14:03:42 +0100 Subject: [PATCH 2/4] [gh-pages] Initialized docs/ folder. --- docs/.nojekyll | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/.nojekyll diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 From fa3b0e63aacc091ddc215c4c3ef03dcecdf993b2 Mon Sep 17 00:00:00 2001 From: Maxime Labelle Date: Fri, 18 Feb 2022 13:59:47 +0100 Subject: [PATCH 3/4] [gh-pages] GitHub actions. --- .github/workflows/build-sphinx.yml | 57 ++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 .github/workflows/build-sphinx.yml diff --git a/.github/workflows/build-sphinx.yml b/.github/workflows/build-sphinx.yml new file mode 100644 index 0000000..eacb8bc --- /dev/null +++ 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 From d73328dec4bdbf465a14768b399650e3f4469ff3 Mon Sep 17 00:00:00 2001 From: Springcomp Date: Fri, 18 Feb 2022 16:19:13 +0100 Subject: [PATCH 4/4] [gh-pages] Fixed relative paths to site pages. --- documentation/_templates/index.html | 12 ++++++------ documentation/_themes/jmespath/layout.html | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/documentation/_templates/index.html b/documentation/_templates/index.html index 40f4518..446a1bd 100644 --- a/documentation/_templates/index.html +++ b/documentation/_templates/index.html @@ -45,12 +45,12 @@

Try it Out!

The expression is evaluated against the JSON data and the result is shown in the result pane.

To learn more about JMESPath, check out the - JMESPath Tutorial and - JMESPath Examples. + JMESPath Tutorial and + JMESPath Examples.

Have questions? Come chat with us.

- JMESPath Tutorial + JMESPath Tutorial
@@ -58,7 +58,7 @@

Try it Out!

A Complete Specification

The JMESPath language is described in an - ABNF grammar with a complete + ABNF grammar with a complete specification. This ensures that the language syntax is precisely defined.

@@ -67,14 +67,14 @@

A compliance test suite

JMESPath has a full suite of data driven testcases. This ensures parity for multiple libraries, and makes it easy for developers to - implement JMESPath in their + implement JMESPath in their language of choice.

Libraries in Multiple Languages

- Each JMESPath library + Each JMESPath library 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/documentation/_themes/jmespath/layout.html b/documentation/_themes/jmespath/layout.html index 2ed1a9d..d22e20e 100644 --- a/documentation/_themes/jmespath/layout.html +++ b/documentation/_themes/jmespath/layout.html @@ -111,11 +111,11 @@