From 42e779c611e9e7fb8496567590969693acdf1ea1 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:28:33 -0600 Subject: [PATCH 01/79] Create sphinx_build_deploy.yml First pass at creating a gh-action for using sphinx to build webpages and deploy to gh-pages --- .github/workflows/sphinx_build_deploy.yml | 34 +++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/workflows/sphinx_build_deploy.yml diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml new file mode 100644 index 0000000..62d0986 --- /dev/null +++ b/.github/workflows/sphinx_build_deploy.yml @@ -0,0 +1,34 @@ +name: Publish Sphinx Built Webpages to Github Pages + +on: + push: + branches: + - master + paths: + - 'docs/**' + +jobs: + release: Build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Setup Python + uses: actions/setup-python@v2 + with: + python-version: '3.8' + + - name: Install dependencies + run: | + sudo apt install pandoc + python -m pip install --upgrade pip + pip install -r requirements.txxt + + - name: Build Sphinx documentation + run: | + make html + + - name: Deploy to gh-pages + uses: peaciris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./site From c115f6d794d311797b9d58b3b36786f936bf650d Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:30:19 -0600 Subject: [PATCH 02/79] Test to see if gh-actions works removed the space between dashes in --force in the environment setup. --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d03f78d..4a78b9a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,7 +23,7 @@ To install the latest version of python-awips, with all required and optional pa - conda env create -f environment.yml - conda activate python3-awips - conda update - -all -- python setup.py install - -force +- python setup.py install --force - jupyter notebook examples Requirements From 804e30ba9ef61c0c070baa4b82622fbeade9e322 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:32:35 -0600 Subject: [PATCH 03/79] Update sphinx_build_deploy.yml was missing a line for "name: " under "release" (line 11) --- .github/workflows/sphinx_build_deploy.yml | 49 ++++++++++++----------- 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 62d0986..42f5e50 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -8,27 +8,28 @@ on: - 'docs/**' jobs: - release: Build - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - name: Setup Python - uses: actions/setup-python@v2 - with: - python-version: '3.8' - - - name: Install dependencies - run: | - sudo apt install pandoc - python -m pip install --upgrade pip - pip install -r requirements.txxt - - - name: Build Sphinx documentation - run: | - make html - - - name: Deploy to gh-pages - uses: peaciris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./site + release: + name: Build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Setup Python + uses: actions/setup-python@v2 + with: + python-version: '3.8' + + - name: Install dependencies + run: | + sudo apt install pandoc + python -m pip install --upgrade pip + pip install -r requirements.txxt + + - name: Build Sphinx documentation + run: | + make html + + - name: Deploy to gh-pages + uses: peaciris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./site From 2bc6a3e3b2e9e54fe5a66e7e6ee280bf8c2c8dfd Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:34:56 -0600 Subject: [PATCH 04/79] test for gh-action added the space back in between --force --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 4a78b9a..d03f78d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,7 +23,7 @@ To install the latest version of python-awips, with all required and optional pa - conda env create -f environment.yml - conda activate python3-awips - conda update - -all -- python setup.py install --force +- python setup.py install - -force - jupyter notebook examples Requirements From 73beeae98ed254fdfd331ba8875359c4aeb92862 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:36:42 -0600 Subject: [PATCH 05/79] Update sphinx_build_deploy.yml spelling mistake with peaceiris --- .github/workflows/sphinx_build_deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 42f5e50..44998f3 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -29,7 +29,7 @@ jobs: make html - name: Deploy to gh-pages - uses: peaciris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./site From e55c9ff64754886cbb8c66e985ee4c3c4d4513c3 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:37:29 -0600 Subject: [PATCH 06/79] test gh-action remove space between -- --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d03f78d..4a78b9a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,7 +23,7 @@ To install the latest version of python-awips, with all required and optional pa - conda env create -f environment.yml - conda activate python3-awips - conda update - -all -- python setup.py install - -force +- python setup.py install --force - jupyter notebook examples Requirements From ad299381c3aa0d03c71c6a1c2f0fddfd7d423030 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:39:24 -0600 Subject: [PATCH 07/79] Update sphinx_build_deploy.yml spelling mistake for "requirements.txt" --- .github/workflows/sphinx_build_deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 44998f3..d41a945 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -22,7 +22,7 @@ jobs: run: | sudo apt install pandoc python -m pip install --upgrade pip - pip install -r requirements.txxt + pip install -r requirements.txt - name: Build Sphinx documentation run: | From d0125ffd52ca2f6da4a36c64b3fbddfe60fced3a Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:42:16 -0600 Subject: [PATCH 08/79] test gh-actions add space --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 4a78b9a..d03f78d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,7 +23,7 @@ To install the latest version of python-awips, with all required and optional pa - conda env create -f environment.yml - conda activate python3-awips - conda update - -all -- python setup.py install --force +- python setup.py install - -force - jupyter notebook examples Requirements From 0ab8d731fc042c9254a6c83ed155676b85580c5f Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:57:54 -0600 Subject: [PATCH 09/79] Update sphinx_build_deploy.yml add a call to update sphinx before running it to build the documentation --- .github/workflows/sphinx_build_deploy.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index d41a945..3e10dfb 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -23,6 +23,10 @@ jobs: sudo apt install pandoc python -m pip install --upgrade pip pip install -r requirements.txt + + - name: Update Sphinx + run: | + pip install -U sphinx - name: Build Sphinx documentation run: | From 7bfeeaf636e120f55a2c0e25b542961ca47dcd9b Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 11:58:32 -0600 Subject: [PATCH 10/79] test gh-actions added a space at end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d03f78d..9ac98db 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From ba1ba71d39e218bd9432336ec728db7e8979967f Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:11:11 -0600 Subject: [PATCH 11/79] Create Makefile Add makefile to the base directory for the gh-action --- Makefile | 218 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 218 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8a7dac0 --- /dev/null +++ b/Makefile @@ -0,0 +1,218 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build +NBCONVERT = ipython nbconvert + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* source/examples/generated/* + +.PHONY: html +html: + make clean + $(SPHINXBUILD) -vb html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-awips.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-awips.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/python-awips" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-awips" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." From 7d0353010771cc987bd3b05404c3d86876642a16 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:11:36 -0600 Subject: [PATCH 12/79] test gh-action remove space from title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ac98db..d03f78d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 7346e5a601a196611d15f3ec7c925b5ccd6d8e64 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:14:51 -0600 Subject: [PATCH 13/79] Update sphinx_build_deploy.yml try specifying the docs/ dir when running things --- .github/workflows/sphinx_build_deploy.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 3e10dfb..4899f37 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -22,7 +22,7 @@ jobs: run: | sudo apt install pandoc python -m pip install --upgrade pip - pip install -r requirements.txt + pip install -r docs/requirements.txt - name: Update Sphinx run: | @@ -30,6 +30,7 @@ jobs: - name: Build Sphinx documentation run: | + cd docs make html - name: Deploy to gh-pages From b0cfd8d8254da3efacc7f6e8b1453ac5d99e51f2 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:15:16 -0600 Subject: [PATCH 14/79] Delete Makefile remove sphinx makefile from root dir --- Makefile | 218 ------------------------------------------------------- 1 file changed, 218 deletions(-) delete mode 100644 Makefile diff --git a/Makefile b/Makefile deleted file mode 100644 index 8a7dac0..0000000 --- a/Makefile +++ /dev/null @@ -1,218 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build -NBCONVERT = ipython nbconvert - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* source/examples/generated/* - -.PHONY: html -html: - make clean - $(SPHINXBUILD) -vb html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-awips.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-awips.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/python-awips" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-awips" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." From 0091e34f28ba590d453d81a9de07ac4816d468c3 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:15:49 -0600 Subject: [PATCH 15/79] test gh-action add space to end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d03f78d..9ac98db 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 9ca213bb98d8a0365ac11d76a980311c9f007bf3 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:17:42 -0600 Subject: [PATCH 16/79] Update sphinx_build_deploy.yml install the readthedocs theme for sphinx --- .github/workflows/sphinx_build_deploy.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 4899f37..088b77b 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -24,9 +24,9 @@ jobs: python -m pip install --upgrade pip pip install -r docs/requirements.txt - - name: Update Sphinx + - name: Install ReadTheDocs theme run: | - pip install -U sphinx + pip install sphinx_rtd_theme - name: Build Sphinx documentation run: | From 8ba0140362260de213df9720feb3df0bc08f9d94 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:18:27 -0600 Subject: [PATCH 17/79] test gh-action remove the space from end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ac98db..d03f78d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From f7945cd5982e53baff14db022a314148cd7aab34 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:22:02 -0600 Subject: [PATCH 18/79] test gh-action added space to end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d03f78d..9ac98db 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 522fb282dc782a54bac817a087083635b6f9c9d1 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:35:46 -0600 Subject: [PATCH 19/79] Update sphinx_build_deploy.yml try changing the gh-pages publish_dir to ./public --- .github/workflows/sphinx_build_deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 088b77b..3bbcfd8 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -37,4 +37,4 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./site + publish_dir: ./public From 0de66e0c946adc579152e45b3f736d7eeb378f22 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:36:12 -0600 Subject: [PATCH 20/79] test gh-action remove space in title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ac98db..d03f78d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 9da5ed0d3e0dc070425514e3910e04f0461add47 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 12:51:41 -0600 Subject: [PATCH 21/79] test gh-actions added space to end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d03f78d..9ac98db 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 41c5e8057cbd46515c1f1a57960694ecb3538951 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 13:09:38 -0600 Subject: [PATCH 22/79] Update sphinx_build_deploy.yml try going back to ./site as the publish_dir --- .github/workflows/sphinx_build_deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 3bbcfd8..088b77b 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -37,4 +37,4 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./public + publish_dir: ./site From 58cbfe820e562a8c14ab147865a4e574386a69dc Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 13:10:05 -0600 Subject: [PATCH 23/79] test gh-pages with ./site as publish dir remove space from title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ac98db..d03f78d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From e506498bb6611568b479a2dcd80624024991414c Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 13:19:00 -0600 Subject: [PATCH 24/79] Update sphinx_build_deploy.yml change publish dir to ./docs/build/html --- .github/workflows/sphinx_build_deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 088b77b..b0d647b 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -37,4 +37,4 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./site + publish_dir: ./docs/build/html From b9fe7b919353bafa89d942f7f629df1ae8f4629e Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 13:19:34 -0600 Subject: [PATCH 25/79] test gh-action with new publish dir add space to end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d03f78d..9ac98db 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 446d5879d3d226737f659c377132acc9a8cb3e69 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 13:28:43 -0600 Subject: [PATCH 26/79] Update index.rst another change to see if the -- will look better --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ac98db..687c0ef 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,7 +23,7 @@ To install the latest version of python-awips, with all required and optional pa - conda env create -f environment.yml - conda activate python3-awips - conda update - -all -- python setup.py install - -force +- python setup.py install -/-force - jupyter notebook examples Requirements From 6f981a42c5ef3a42d686d2c565679459a355f09a Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 13:35:44 -0600 Subject: [PATCH 27/79] Update index.rst small changes for the double dash, remove space from title --- docs/source/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 687c0ef..c5e7916 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. @@ -22,8 +22,8 @@ To install the latest version of python-awips, with all required and optional pa - cd python-awips - conda env create -f environment.yml - conda activate python3-awips -- conda update - -all -- python setup.py install -/-force +- conda update - -all +- python setup.py install - -force - jupyter notebook examples Requirements From 9784720a4e1106245d290388cb2b6b603ffee531 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 13:48:00 -0600 Subject: [PATCH 28/79] Update index.rst test to see if I successfully changed the environment instructions to "code" rendering --- docs/source/index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index c5e7916..048ca1d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,6 +26,17 @@ To install the latest version of python-awips, with all required and optional pa - python setup.py install - -force - jupyter notebook examples +:: + + git clone https://github.com/Unidata/python-awips.git + cd python-awips + conda env create -f environment.yml + conda activate python3-awips + conda update --all + python setup.py install --force + jupyter notebook examples + + Requirements ------------ From b71392806d57fb5dcceb8c8c37082a035801aa98 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 13:54:44 -0600 Subject: [PATCH 29/79] Update index.rst remove the bulleted list of environment commands since the code commands render better and should be used anyway --- docs/source/index.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 048ca1d..c83e58d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -18,14 +18,6 @@ Conda Environment Install To install the latest version of python-awips, with all required and optional packages: -- git clone https://github.com/Unidata/python-awips.git -- cd python-awips -- conda env create -f environment.yml -- conda activate python3-awips -- conda update - -all -- python setup.py install - -force -- jupyter notebook examples - :: git clone https://github.com/Unidata/python-awips.git From 2fff8e513462c4d03275a55f0066e83f6baaa42e Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:04:01 -0600 Subject: [PATCH 30/79] Update requirements.txt Setting the sphinx version to 1.3 to see if it fixes the auto-generated jupyter notebooks pages. --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 282356c..e5aa1d6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx>=1.3 +sphinx==1.3 nbconvert>=4.1 enum34 jupyter From af08f6b270add9514a451bd40200871f9c94530d Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:04:38 -0600 Subject: [PATCH 31/79] Update index.rst Make the pip download command a "code" block --- docs/source/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index c83e58d..00daaf9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,7 +11,9 @@ The python-awips package provides a data access framework for requesting grid an Pip Install ----------- -- pip install python-awips +:: + + pip install python-awips Conda Environment Install ------------------------- From 6db0939a5d8ec27ec5b6079795fac99f8338c557 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:08:31 -0600 Subject: [PATCH 32/79] Update requirements.txt Changing sphinx version back to greater than 1.3 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index e5aa1d6..282356c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==1.3 +sphinx>=1.3 nbconvert>=4.1 enum34 jupyter From bd32e9af7ce83f983a3f0e72059909cb07623766 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:14:31 -0600 Subject: [PATCH 33/79] Update sphinx_build_deploy.yml First pass at trying to add caching for dependencies. --- .github/workflows/sphinx_build_deploy.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index b0d647b..85e0a58 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -18,10 +18,25 @@ jobs: with: python-version: '3.8' + - name: Install pip + run: | + python -m pip install --upgrade pip + + - name: Get pip cache dir + id: pip-cache + run : echo "::set-output name=dir::$(pip cache dir)" + + - name: Cache dependencies + uses: actions/cache@v1 + with: + path: ${{ steps.pip-cache.outputs.dir }} + key: ${{ runner.os }}-pip-${{ hashFiles{'docs/requirements.txt') }} + restore-keys: | + ${{ runner.os }}-pip- + - name: Install dependencies run: | sudo apt install pandoc - python -m pip install --upgrade pip pip install -r docs/requirements.txt - name: Install ReadTheDocs theme From e27ea3fe49f7d158c2a03d3f5c59bce5812d5e6a Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:15:23 -0600 Subject: [PATCH 34/79] Update index.rst Add a new line after the pip install command. Trigger new website build. --- docs/source/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index 00daaf9..1b768fc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,6 +15,7 @@ Pip Install pip install python-awips + Conda Environment Install ------------------------- From 97eab3f8c2df81248e88a4c8ae0537d3ce27a959 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:18:19 -0600 Subject: [PATCH 35/79] Update sphinx_build_deploy.yml fix for hashfiles in caching --- .github/workflows/sphinx_build_deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 85e0a58..7c73330 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -30,7 +30,7 @@ jobs: uses: actions/cache@v1 with: path: ${{ steps.pip-cache.outputs.dir }} - key: ${{ runner.os }}-pip-${{ hashFiles{'docs/requirements.txt') }} + key: ${{ runner.os }}-pip-${{ hashFiles{'**/docs/requirements.txt') }} restore-keys: | ${{ runner.os }}-pip- From 7a514c52114ea9b58c8038fe9a20f41d86071144 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:19:07 -0600 Subject: [PATCH 36/79] test gh-action added space to end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1b768fc..47c1696 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 08aceefa76c6b33008747fa12e9c825ce97d8459 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:20:39 -0600 Subject: [PATCH 37/79] Update sphinx_build_deploy.yml fix for proper parenthesis in hashFiles cache line --- .github/workflows/sphinx_build_deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 7c73330..502561a 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -30,7 +30,7 @@ jobs: uses: actions/cache@v1 with: path: ${{ steps.pip-cache.outputs.dir }} - key: ${{ runner.os }}-pip-${{ hashFiles{'**/docs/requirements.txt') }} + key: ${{ runner.os }}-pip-${{ hashFiles('**/docs/requirements.txt') }} restore-keys: | ${{ runner.os }}-pip- From 8c01f28dfef010682497f314f13366de1e5ca4bd Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:21:19 -0600 Subject: [PATCH 38/79] test gh-action remove space from end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 47c1696..1b768fc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From a0b0bb66402ec77b4251a9812402ec913eed555c Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:24:22 -0600 Subject: [PATCH 39/79] test gh-action added space at end of title --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1b768fc..47c1696 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From f48d6c720b7628877338bff56d3c6f0e5193edf2 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 2 Sep 2020 16:29:40 -0600 Subject: [PATCH 40/79] Update sphinx_build_deploy.yml comment out caching since it doesn't quite work right anyway --- .github/workflows/sphinx_build_deploy.yml | 28 ++++++++++++----------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 502561a..57dad7b 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -18,25 +18,27 @@ jobs: with: python-version: '3.8' - - name: Install pip - run: | - python -m pip install --upgrade pip +# Caching works, but then it reinstalls the regular dependencies anyway, so defeats the purpose of caching. +# - name: Install pip +# run: | +# python -m pip install --upgrade pip - - name: Get pip cache dir - id: pip-cache - run : echo "::set-output name=dir::$(pip cache dir)" +# - name: Get pip cache dir +# id: pip-cache +# run : echo "::set-output name=dir::$(pip cache dir)" - - name: Cache dependencies - uses: actions/cache@v1 - with: - path: ${{ steps.pip-cache.outputs.dir }} - key: ${{ runner.os }}-pip-${{ hashFiles('**/docs/requirements.txt') }} - restore-keys: | - ${{ runner.os }}-pip- +# - name: Cache dependencies +# uses: actions/cache@v1 +# with: +# path: ${{ steps.pip-cache.outputs.dir }} +# key: ${{ runner.os }}-pip-${{ hashFiles('**/docs/requirements.txt') }} +# restore-keys: | +# ${{ runner.os }}-pip- - name: Install dependencies run: | sudo apt install pandoc + python -m pip install --upgrade pip pip install -r docs/requirements.txt - name: Install ReadTheDocs theme From 99f7dfb9506c19f2b600d29f1affadd7b9864f5c Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 00:59:59 -0600 Subject: [PATCH 41/79] Update requirements.txt try sphinx v 2.1 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 282356c..366519e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx>=1.3 +sphinx==2.1 nbconvert>=4.1 enum34 jupyter From fa15129837e27f5c4d63917d254c2f7d17e95aca Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:02:50 -0600 Subject: [PATCH 42/79] Update index.rst re-run gh-actions to see if this version works --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 47c1696..1b768fc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 4398fed52eb852a5dba989f5da776af6f770b53e Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:05:28 -0600 Subject: [PATCH 43/79] Update requirements.txt v. 3.1 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 366519e..bbd302c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.1 +sphinx==3.1 nbconvert>=4.1 enum34 jupyter From 6abba1ed5346b1e9392830c9d1846c61f6dd0697 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:06:02 -0600 Subject: [PATCH 44/79] Update index.rst --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1b768fc..47c1696 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From c4a4bfa58e1e6cb460d1246c990dbb1fa11915f6 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:08:47 -0600 Subject: [PATCH 45/79] sphinx 1.4 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index bbd302c..be91861 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==3.1 +sphinx==1.4 nbconvert>=4.1 enum34 jupyter From d647fbf17ce435ad5c2b26dd3e5a4405d1754d5e Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:09:07 -0600 Subject: [PATCH 46/79] Update index.rst --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 47c1696..81506f8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 73b4429f4b1e3e36baacf626c9c435d4ec7f944d Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:12:36 -0600 Subject: [PATCH 47/79] sphinx 1.5 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index be91861..ab0e82d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==1.4 +sphinx==1.5 nbconvert>=4.1 enum34 jupyter From 337b2a1ac8488d2b91aff7fa7356e65aec825d53 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:13:54 -0600 Subject: [PATCH 48/79] Update index.rst --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 81506f8..47c1696 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 9b5275ecad9d91c7e23697e065dd2e8f49bb3e78 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:15:58 -0600 Subject: [PATCH 49/79] sphinx 1.6 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index ab0e82d..57634be 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==1.5 +sphinx==1.6 nbconvert>=4.1 enum34 jupyter From c404a9a7e42f72b46090b247b9a30d5a9fd7ea5a Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:17:45 -0600 Subject: [PATCH 50/79] sphinx 1.7 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 57634be..b3f10ce 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==1.6 +sphinx==1.7 nbconvert>=4.1 enum34 jupyter From 2f15dc41c54b791b822ea6b043d7993f121f20bc Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:20:38 -0600 Subject: [PATCH 51/79] sphinx 1.8 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index b3f10ce..a2bb402 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==1.7 +sphinx==1.8 nbconvert>=4.1 enum34 jupyter From 7ca472e1b8bc0e7c0f9092083c3ab4c072577a33 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:22:52 -0600 Subject: [PATCH 52/79] sphinx 1.9 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index a2bb402..b77faba 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==1.8 +sphinx==1.9 nbconvert>=4.1 enum34 jupyter From 6ab41242a36cde37a32e45b1a29241f7ce32d6be Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:23:48 -0600 Subject: [PATCH 53/79] sphinx 2.0 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index b77faba..d740efe 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==1.9 +sphinx==2.0 nbconvert>=4.1 enum34 jupyter From 63384f7bfeaebd92ca43846f264f7af00eee1c56 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:26:07 -0600 Subject: [PATCH 54/79] sphinx 2.2 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index d740efe..ef2a3dc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.0 +sphinx==2.2 nbconvert>=4.1 enum34 jupyter From 30eb7a58dc6c9f70ceb66d8d4dbc3a5e151e3d71 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:30:01 -0600 Subject: [PATCH 55/79] sphinx 2.3 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index ef2a3dc..291022f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.2 +sphinx==2.3 nbconvert>=4.1 enum34 jupyter From 3e752d50936ea7ed0ef147c472b659f72a8e950a Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:31:57 -0600 Subject: [PATCH 56/79] sphinx 2.4 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 291022f..4923396 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.3 +sphinx==2.4 nbconvert>=4.1 enum34 jupyter From d53452fa479554d41689bb7471c08b2564c0b6e1 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:34:31 -0600 Subject: [PATCH 57/79] sphinx 2.5 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 4923396..ddff9e6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.4 +sphinx==2.5 nbconvert>=4.1 enum34 jupyter From 14858d5c45d43df1d7a9a25b62e15d045c50c7f3 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:37:56 -0600 Subject: [PATCH 58/79] sphinx 2.6 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index ddff9e6..aefdaee 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.5 +sphinx==2.6 nbconvert>=4.1 enum34 jupyter From f82d96198cfd10dbae36f51ec2b5a118aabdb3e7 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:39:44 -0600 Subject: [PATCH 59/79] sphinx 2.7 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index aefdaee..fe5c076 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.6 +sphinx==2.7 nbconvert>=4.1 enum34 jupyter From defc2c35ffa4bcb9ecf1a70c79ccfb35b5cfd88e Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:42:28 -0600 Subject: [PATCH 60/79] sphinx 2.8 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index fe5c076..f4329b8 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.7 +sphinx==2.8 nbconvert>=4.1 enum34 jupyter From 1577263a7437a911162091952ba3865384c99e89 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:43:37 -0600 Subject: [PATCH 61/79] sphinx 2.9 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index f4329b8..878f94e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.8 +sphinx==2.9 nbconvert>=4.1 enum34 jupyter From b80ee45b173f08bd7651f322d20a08a815490baa Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:45:24 -0600 Subject: [PATCH 62/79] sphinx 3.0 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 878f94e..720ee33 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==2.9 +sphinx==3.0 nbconvert>=4.1 enum34 jupyter From 5cfbfe1cd8cbf7254edc525ed9d124b5b5f3225d Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 01:53:35 -0600 Subject: [PATCH 63/79] sphinx 1.3 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 720ee33..e5aa1d6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==3.0 +sphinx==1.3 nbconvert>=4.1 enum34 jupyter From 95452917603492cd9f61803dcc379827364672cf Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Thu, 3 Sep 2020 02:06:17 -0600 Subject: [PATCH 64/79] sphinx >= 1.3 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index e5aa1d6..282356c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx==1.3 +sphinx>=1.3 nbconvert>=4.1 enum34 jupyter From fe870f109148e88d5252775a09e80ef130195471 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Fri, 4 Sep 2020 11:34:43 -0600 Subject: [PATCH 65/79] Trigger website rebuild --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 47c1696..1b768fc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 68674182abfe8dd6ae1e7f68b8f5df7cd70ccb08 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Fri, 4 Sep 2020 12:02:00 -0600 Subject: [PATCH 66/79] try changing matplotlib 'inline' for 'notebook' --- examples/notebooks/Grid_Levels_and_Parameters.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/notebooks/Grid_Levels_and_Parameters.ipynb b/examples/notebooks/Grid_Levels_and_Parameters.ipynb index b2ee0d8..f46de10 100644 --- a/examples/notebooks/Grid_Levels_and_Parameters.ipynb +++ b/examples/notebooks/Grid_Levels_and_Parameters.ipynb @@ -894,7 +894,7 @@ } ], "source": [ - "%matplotlib inline\n", + "%matplotlib notebook\n", "import matplotlib.pyplot as plt\n", "import matplotlib\n", "import cartopy.crs as ccrs\n", From eca2e1506ac316fffa531da65845f0318426f325 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Fri, 4 Sep 2020 12:05:19 -0600 Subject: [PATCH 67/79] run gh-action on change to examples dir --- .github/workflows/sphinx_build_deploy.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index 57dad7b..fe90b22 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -6,6 +6,7 @@ on: - master paths: - 'docs/**' + - 'examples/**' jobs: release: From e8e1e429868e7212baf968a7f5b459f460c68513 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Fri, 4 Sep 2020 12:05:42 -0600 Subject: [PATCH 68/79] rebuild webpages --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1b768fc..47c1696 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From d72ee3d740056b382a372aa94e34ceb8bed93291 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Fri, 4 Sep 2020 13:55:22 -0600 Subject: [PATCH 69/79] rebuild website --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 47c1696..1b768fc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 430e9ccecdb8522455738d4a53d5c4e635076531 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 11:18:35 -0600 Subject: [PATCH 70/79] Move the %matplotlib inline code to after imports --- .../notebooks/Colored_Surface_Temperature_Plot.ipynb | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/examples/notebooks/Colored_Surface_Temperature_Plot.ipynb b/examples/notebooks/Colored_Surface_Temperature_Plot.ipynb index cf86623..4b10da3 100644 --- a/examples/notebooks/Colored_Surface_Temperature_Plot.ipynb +++ b/examples/notebooks/Colored_Surface_Temperature_Plot.ipynb @@ -1,14 +1,5 @@ { "cells": [ - { - "cell_type": "code", - "execution_count": 63, - "metadata": {}, - "outputs": [], - "source": [ - "%matplotlib inline" - ] - }, { "cell_type": "markdown", "metadata": {}, @@ -53,6 +44,7 @@ "from cartopy.feature import ShapelyFeature\n", "from shapely.geometry import Polygon\n", "from metpy.plots import StationPlot\n", + "%matplotlib inline\n", "\n", "# CONUS bounding box and envelope geometry\n", "bbox=[-120, -70, 15, 55]\n", From 6973e227e6920b74e98c8c632144d8d33959d046 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 11:28:29 -0600 Subject: [PATCH 71/79] move "matplotlib inline" after imports --- examples/notebooks/METAR_Station_Plot_with_MetPy.ipynb | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/examples/notebooks/METAR_Station_Plot_with_MetPy.ipynb b/examples/notebooks/METAR_Station_Plot_with_MetPy.ipynb index 474d05b..9a53894 100644 --- a/examples/notebooks/METAR_Station_Plot_with_MetPy.ipynb +++ b/examples/notebooks/METAR_Station_Plot_with_MetPy.ipynb @@ -1,14 +1,5 @@ { "cells": [ - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "%matplotlib inline" - ] - }, { "cell_type": "markdown", "metadata": {}, @@ -33,6 +24,7 @@ "from metpy.plots import StationPlot, StationPlotLayout\n", "from metpy.units import units\n", "import warnings\n", + "%matplotlib inline\n", "warnings.filterwarnings(\"ignore\",category =RuntimeWarning)\n", "\n", "def get_cloud_cover(code):\n", From 1b39c048568f53b22dc89e09b4a5724316aa3f61 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 11:41:27 -0600 Subject: [PATCH 72/79] Moved '%matplotlib inline' for surface obs notebook --- examples/notebooks/Regional_Surface_Obs_Plot.ipynb | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/examples/notebooks/Regional_Surface_Obs_Plot.ipynb b/examples/notebooks/Regional_Surface_Obs_Plot.ipynb index 9bfe3a0..30aa2d7 100644 --- a/examples/notebooks/Regional_Surface_Obs_Plot.ipynb +++ b/examples/notebooks/Regional_Surface_Obs_Plot.ipynb @@ -1,14 +1,5 @@ { "cells": [ - { - "cell_type": "code", - "execution_count": 1, - "metadata": {}, - "outputs": [], - "source": [ - "%matplotlib inline" - ] - }, { "cell_type": "markdown", "metadata": {}, @@ -35,6 +26,7 @@ "from metpy.calc import wind_components\n", "from metpy.plots import simple_layout, StationPlot, StationPlotLayout\n", "import warnings\n", + "%matplotlib inline\n", "\n", "def get_cloud_cover(code):\n", " if 'OVC' in code:\n", From 8606c4d50a542615fad45736fda35c874a0a9fc5 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 12:32:53 -0600 Subject: [PATCH 73/79] change automodule to autoclass for DataAccessLayer --- docs/source/api/DataAccessLayer.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/api/DataAccessLayer.rst b/docs/source/api/DataAccessLayer.rst index e000038..ab748a8 100644 --- a/docs/source/api/DataAccessLayer.rst +++ b/docs/source/api/DataAccessLayer.rst @@ -2,6 +2,6 @@ DataAccessLayer =============== -.. automodule:: awips.dataaccess.DataAccessLayer +.. autoclass:: awips.dataaccess.DataAccessLayer :members: :undoc-members: From faf2fc5771248cd379ceff04df36fe1347117a24 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 12:36:39 -0600 Subject: [PATCH 74/79] Changing back to automodule --- docs/source/api/DataAccessLayer.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/api/DataAccessLayer.rst b/docs/source/api/DataAccessLayer.rst index ab748a8..e000038 100644 --- a/docs/source/api/DataAccessLayer.rst +++ b/docs/source/api/DataAccessLayer.rst @@ -2,6 +2,6 @@ DataAccessLayer =============== -.. autoclass:: awips.dataaccess.DataAccessLayer +.. automodule:: awips.dataaccess.DataAccessLayer :members: :undoc-members: From 95f190e9360fecaf012e1d4ef180cce3fa96fe29 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 12:39:00 -0600 Subject: [PATCH 75/79] add numpy to docs requirements --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 282356c..cc19438 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ nbconvert>=4.1 enum34 jupyter shapely +numpy From cee1f986f4906e8ef6908357b2a5906b484c3ec1 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 12:42:53 -0600 Subject: [PATCH 76/79] rebuild website --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1b768fc..47c1696 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 0f14592dac3d60ddeb14945d83723ca162cde84e Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 12:45:16 -0600 Subject: [PATCH 77/79] rebuild website --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 47c1696..1b768fc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ ================================== -Python AWIPS Data Access Framework +Python AWIPS Data Access Framework ================================== The python-awips package provides a data access framework for requesting grid and geometry datasets from an `EDEX `_ server. From 557dd8f348e25f40efaf55ac45e02e491e240a0f Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 12:46:13 -0600 Subject: [PATCH 78/79] removed the 'conda update --all' call from environment setup --- docs/source/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 1b768fc..237af52 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -27,7 +27,6 @@ To install the latest version of python-awips, with all required and optional pa cd python-awips conda env create -f environment.yml conda activate python3-awips - conda update --all python setup.py install --force jupyter notebook examples From fc30adadea497a56568b45d861c933afcdc80b45 Mon Sep 17 00:00:00 2001 From: srcarter3 Date: Wed, 9 Sep 2020 13:40:15 -0600 Subject: [PATCH 79/79] changed '%matplotlib notebook' back to '%matplotlib inline' --- examples/notebooks/Grid_Levels_and_Parameters.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/notebooks/Grid_Levels_and_Parameters.ipynb b/examples/notebooks/Grid_Levels_and_Parameters.ipynb index a4be55e..78262f2 100644 --- a/examples/notebooks/Grid_Levels_and_Parameters.ipynb +++ b/examples/notebooks/Grid_Levels_and_Parameters.ipynb @@ -892,7 +892,7 @@ } ], "source": [ - "%matplotlib notebook\n", + "%matplotlib inline\n", "import matplotlib.pyplot as plt\n", "import matplotlib\n", "import cartopy.crs as ccrs\n",