From 1a48f263444b332c4b414e69783c6a0dc1c6b2ff Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Mon, 24 Apr 2023 14:27:40 -0400 Subject: [PATCH 01/14] Add logo to readme --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64f1c3ae..1d7259ae 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# PyHyperScattering +![# PyHyperScattering](https://user-images.githubusercontent.com/875623/234083915-e62ee2d4-ad7f-4d91-a847-18fa54652ffc.png) + Python utilities for loading, reducing, slicing, and plotting hyperspectral scattering datasets. This is a package approaching scope-completeness, but still under extremely active development and notably without any guarantee of API stability (we do try to not change things without reason, though). An increasing number of parts of it are unit-tested for functionality, stability, and/or scientific correctness, but large swaths are not. Its documentation is certainly lacking and we are actively seeking help in generating good documentation (see the Issues page on github for areas). Use at your own risk. If you're interested in contributing, please contact Peter Beaucage (peter.beaucage@nist.gov). From 6b20b80a6a55f7858d36f9e0892800bc1886d1bd Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Fri, 11 Aug 2023 14:24:46 -0400 Subject: [PATCH 02/14] Create doc publish workflow --- .github/workflows/publish-docs.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/workflows/publish-docs.yml diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml new file mode 100644 index 00000000..0c046491 --- /dev/null +++ b/.github/workflows/publish-docs.yml @@ -0,0 +1,14 @@ +name: "Publish Documentation to NIST Pages" + +on: [push, pull_request, delete] + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: usnistgov/NISTtheDocs2Death@0.3 + with: + docs-folder: docs/ + formats: |- + epub + pdf From 2886a4be43ca0ae87e5e763e3d4db2e56302a14e Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Wed, 6 Sep 2023 16:42:01 -0400 Subject: [PATCH 03/14] Add pip requirements file link to NISTthedocs script --- .github/workflows/publish-docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 0c046491..0bbe31ef 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -12,3 +12,4 @@ jobs: formats: |- epub pdf + pip-requirements: requirements.txt From be4d2ad714c999e6bc67c7c247a645346ae10671 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Thu, 7 Sep 2023 12:59:35 -0400 Subject: [PATCH 04/14] syntax fix pip requirements --- .github/workflows/publish-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 0bbe31ef..afc36053 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -12,4 +12,4 @@ jobs: formats: |- epub pdf - pip-requirements: requirements.txt + pip-requirements: 'requirements.txt' From 840acd0952bef6194fa7a035b94252017edb49a9 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Thu, 7 Sep 2023 13:07:37 -0400 Subject: [PATCH 05/14] Use newer version of NTD2D --- .github/workflows/publish-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index afc36053..22b79312 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -6,7 +6,7 @@ jobs: docs: runs-on: ubuntu-latest steps: - - uses: usnistgov/NISTtheDocs2Death@0.3 + - uses: usnistgov/NISTtheDocs2Death@0.4 with: docs-folder: docs/ formats: |- From 533b5aae85732917bd1c3435feaf0bed3ccf7d44 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Thu, 7 Sep 2023 13:29:27 -0400 Subject: [PATCH 06/14] Add sphinx rtd theme to dependencies --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 7d7c332f..8fa43a32 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,3 +11,4 @@ scipy pillow xarray tqdm +sphinx-rtd-theme From 9d220f0a278a87e2eb98734620f6e0e847d8a1d0 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Thu, 7 Sep 2023 16:09:38 -0400 Subject: [PATCH 07/14] Try to fix RTD theme by commenting static dir --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 08f3a2fc..3617c897 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,7 +56,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# try commenting out? html_static_path = ['_static'] import sys sys.path.append('../src/') From 0d29f9a21595b7fee3f2b2550af41b49d339fd61 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Thu, 7 Sep 2023 17:20:39 -0400 Subject: [PATCH 08/14] try explicitly including rtd theme --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 3617c897..784351c6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,7 +34,8 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.coverage', -'sphinx.ext.napoleon' +'sphinx.ext.napoleon', +'sphinx_rtd_theme' ] # Add any paths that contain templates here, relative to this directory. From f394b1f93b31ad49214ad9f41fdb5455aee65530 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Thu, 7 Sep 2023 17:29:11 -0400 Subject: [PATCH 09/14] Update conf.py --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 784351c6..62eac3e2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -57,7 +57,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -# try commenting out? html_static_path = ['_static'] +html_static_path = ['_static'] import sys sys.path.append('../src/') From 16f595c9fab3697141073c5f9842fbc1cec16ca4 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Thu, 7 Sep 2023 17:43:34 -0400 Subject: [PATCH 10/14] Update conf.py --- docs/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 62eac3e2..4da273ee 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,7 +35,6 @@ 'sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon', -'sphinx_rtd_theme' ] # Add any paths that contain templates here, relative to this directory. @@ -52,7 +51,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +html_theme = 'piccolo_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 42e3a46ea5f397f69d16da788a2cec5adba77c91 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Thu, 7 Sep 2023 17:45:12 -0400 Subject: [PATCH 11/14] Update requirements.txt --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 8fa43a32..66996210 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,4 +11,4 @@ scipy pillow xarray tqdm -sphinx-rtd-theme +piccolo-theme From 001623135bf0ae6605cd79061ca9bfcebb1200d9 Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Fri, 8 Sep 2023 00:05:58 -0400 Subject: [PATCH 12/14] switch to alabaster --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 4da273ee..5f7470b9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,7 +51,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'piccolo_theme' +html_theme = 'alabaster' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 622425c6f9ebb01771b77ee2c2276c2b015d3d4d Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Mon, 11 Sep 2023 10:51:09 -0400 Subject: [PATCH 13/14] Add new docs link to readme and remove readthedocs. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d7259ae..d540a632 100755 --- a/README.md +++ b/README.md @@ -4,8 +4,9 @@ Python utilities for loading, reducing, slicing, and plotting hyperspectral scat This is a package approaching scope-completeness, but still under extremely active development and notably without any guarantee of API stability (we do try to not change things without reason, though). An increasing number of parts of it are unit-tested for functionality, stability, and/or scientific correctness, but large swaths are not. Its documentation is certainly lacking and we are actively seeking help in generating good documentation (see the Issues page on github for areas). Use at your own risk. If you're interested in contributing, please contact Peter Beaucage (peter.beaucage@nist.gov). +The (quite incomplete) documentation is located at https://pages.nist.gov/PyHyperScattering, and the tutorials in the repository are occasionally helpful. Several core developers are active on the NIST RSoXS slack, Nikea, and NSLS2 slacks and welcome DMs with questions, or email Peter Beaucage. + [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/usnistgov/PyHyperScattering/HEAD) -[![Documentation Status](https://readthedocs.org/projects/pyhyperscattering/badge/?version=latest)](https://pyhyperscattering.readthedocs.io/en/latest/?badge=latest) ![Unit Tests](https://github.com/usnistgov/PyHyperScattering/actions/workflows/main.yml/badge.svg) ![CodeQL](https://github.com/usnistgov/PyHyperScattering/actions/workflows/codeql-analysis.yml/badge.svg) From 2b27bd8ec1c409e6e2090dcd608bbda0a9cfd3af Mon Sep 17 00:00:00 2001 From: Peter Beaucage Date: Mon, 11 Sep 2023 10:51:33 -0400 Subject: [PATCH 14/14] remove old theme from requirements --- requirements.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 66996210..7d7c332f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,4 +11,3 @@ scipy pillow xarray tqdm -piccolo-theme