feat: added functions for NASA Earthdata AWS S3 endpoints

.github/workflows/auto-update-bulletin-a.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up pixi environment
-      uses: prefix-dev/setup-pixi@v0.9.1
+      uses: prefix-dev/setup-pixi@v0.9.6
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

.github/workflows/auto-update-files.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up pixi environment
-      uses: prefix-dev/setup-pixi@v0.9.1
+      uses: prefix-dev/setup-pixi@v0.9.6
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

.github/workflows/python-request.yml

@@ -33,7 +33,7 @@ jobs:
     steps:
     - uses: actions/checkout@v6
     - name: Set up pixi environment
-      uses: prefix-dev/setup-pixi@v0.9.4
+      uses: prefix-dev/setup-pixi@v0.9.6
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

.github/workflows/sphinx-build.yml

@@ -0,0 +1,39 @@
+name: "Sphinx Build"
+
+on:
+  pull_request:
+    paths:
+      - timescale/**
+      - doc/**
+      - .github/workflows/sphinx-build.yml
+    types: [opened, synchronize, reopened, ready_for_review]
+
+# set permissions for the workflow
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  docs:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    env:
+      SPHINXOPTS: "--fail-on-warning --fresh-env --keep-going --warning-file=sphinx.log"
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up pixi environment
+      uses: prefix-dev/setup-pixi@v0.9.6
+    - name: Compile Sphinx Documentation
+      run: |
+        # run a build of the documentation
+        pixi run --environment=dev docs
+    - name: Archive Sphinx Warnings
+      if: github.event.pull_request.head.repo.full_name == github.repository
+      uses: actions/upload-artifact@v6
+      with:
+        name: sphinx-log
+        path: doc/sphinx.log

CITATION.cff

@@ -41,9 +41,9 @@ contributors:
     affiliation: National Science Foundation
 
 contact:
-- family-names: Sutterley
-  given-names: Tyler C.
-  orcid: "https://orcid.org/0000-0002-6964-1194"
+  - family-names: Sutterley
+    given-names: Tyler C.
+    orcid: "https://orcid.org/0000-0002-6964-1194"
 
 identifiers:
   - type: doi

README.md

@@ -91,12 +91,6 @@ pixi shell
 - [numpy: Scientific Computing Tools For Python](https://www.numpy.org)
 - [scipy: Scientific Tools for Python](https://www.scipy.org/)
 
-## References
-
-> T. C. Sutterley, T. Markus, T. A. Neumann, M. R. van den Broeke, J. M. van Wessem, and S. R. M. Ligtenberg,
-> "Antarctic ice shelf thickness change from multimission lidar mapping", *The Cryosphere*,
-> 13, 1801-1817, (2019). [doi: 10.5194/tc-13-1801-2019](https://doi.org/10.5194/tc-13-1801-2019)
-
 ## Download
 
 The program homepage is:  
@@ -116,6 +110,12 @@ The software is provided here for your convenience but *with no guarantees whats
 This project contains work and contributions from the [scientific community](./CONTRIBUTORS.md).
 If you would like to contribute to the project, please have a look at the [contribution guidelines](./doc/source/getting_started/Contributing.rst), [open issues](https://github.com/pyTMD/timescale/issues) and [discussions board](https://github.com/pyTMD/timescale/discussions).
 
+## References
+
+> T. C. Sutterley, T. Markus, T. A. Neumann, M. R. van den Broeke, J. M. van Wessem, and S. R. M. Ligtenberg,
+> "Antarctic ice shelf thickness change from multimission lidar mapping", *The Cryosphere*,
+> 13, 1801-1817, (2019). [doi: 10.5194/tc-13-1801-2019](https://doi.org/10.5194/tc-13-1801-2019)
+
 ## License
 
 The content of this project is licensed under the [Creative Commons Attribution 4.0 Attribution license](https://creativecommons.org/licenses/by/4.0/) and the source code is licensed under the [MIT license](LICENSE).

doc/source/api_reference/eop.rst

@@ -22,6 +22,8 @@ General Methods
 
 .. autofunction:: timescale.eop.pull_pole_coordinates
 
+.. autofunction:: timescale.eop.validate_finals_file
+
 .. autofunction:: timescale.eop.update_finals_file
 
 .. autofunction:: timescale.eop.iers_mean_pole

doc/source/api_reference/time.rst

@@ -81,6 +81,10 @@ General Methods
 
 .. autofunction:: timescale.time.update_leap_seconds
 
+.. autofunction:: timescale.time.validate_delta_time
+
+.. autofunction:: timescale.time.update_delta_time
+
 .. autofunction:: timescale.time.merge_delta_time
 
 .. autofunction:: timescale.time.append_delta_time

doc/source/conf.py

@@ -22,6 +22,7 @@
 
 # -- Project information -----------------------------------------------------
 on_rtd = os.environ.get("READTHEDOCS") == "True"
+on_github = os.environ.get("GITHUB_ACTIONS") == "true"
 
 # package metadata
 metadata = importlib.metadata.metadata("timescale")
@@ -100,21 +101,27 @@
     name, _, url = project_url.partition(", ")
     project_urls[name.lower()] = url
 # fetch the repository url
-repository_url = project_urls.get("repository")
+github_url = project_urls.get("repository")
+*_, github_user, github_repo = github_url.split("/")
 # add html context
 html_context = {
+    "display_github": True,
+    "github_user": github_user,
+    "github_repo": github_repo,
+    "github_version": "main",
+    "conf_py_path": "/doc/source/",
     "menu_links": [
         (
             '<i class="fa fa-github fa-fw"></i> Source Code',
-            repository_url,
+            github_url,
         ),
         (
             '<i class="fa fa-book fa-fw"></i> License',
-            f"{repository_url}/blob/main/LICENSE",
+            f"{github_url}/blob/main/LICENSE",
         ),
         (
             '<i class="fa fa-comment fa-fw"></i> Discussions',
-            f"{repository_url}/discussions",
+            f"{github_url}/discussions",
         ),
     ],
 }