diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 9f79224f..168ab16d 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -84,7 +84,6 @@ jobs: if: steps.filter.outputs.docs == 'true' || github.event_name == 'workflow_dispatch' uses: lsst-sqre/run-tox@v1 with: - cache-key-prefix: docs python-version: ${{ env.PYTHON_VERSION }} tox-envs: docs tox-requirements: requirements/tox.txt diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a39cd0d..b3be8050 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -92,7 +92,7 @@ Find changes for the upcoming release in the project's [changelog.d](https://git ### Backwards-incompatible changes -- GitHub CI and refresh app config are now each a separate, all-or-nothing set of config that comes from a mix of a yaml file and env vars. This requires some new and different Helm values in Phalanx (see https://mobu.lsst.io/operations/github_ci_app.html#add-phalanx-configuration) +- GitHub CI and refresh app config are now each a separate, all-or-nothing set of config that comes from a mix of a yaml file and env vars. This requires some new and different Helm values in Phalanx (see https://mobu.lsst.io/operations/github-ci-app.html#add-phalanx-configuration) - The GitHub CI app now takes the scopes it assigns from config values, rather than hardcoding a list of scopes. diff --git a/docs/index.rst b/docs/index.rst index 16e9b560..530a8f26 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,7 @@ :maxdepth: 1 :hidden: - user_guide/index + user-guide/index operations/index development/index api @@ -27,7 +27,7 @@ mobu is on github at https://github.com/lsst-sqre/mobu. .. grid:: 3 .. grid-item-card:: User Guide - :link: user_guide/index + :link: user-guide/index :link-type: doc Learn how to configure mobu to run your run and test your code. diff --git a/docs/operations/github_ci_app.rst b/docs/operations/github-ci-app.rst similarity index 100% rename from docs/operations/github_ci_app.rst rename to docs/operations/github-ci-app.rst diff --git a/docs/operations/github_refresh_app.rst b/docs/operations/github-refresh-app.rst similarity index 100% rename from docs/operations/github_refresh_app.rst rename to docs/operations/github-refresh-app.rst diff --git a/docs/operations/index.rst b/docs/operations/index.rst index 7be148c6..dd06fe67 100644 --- a/docs/operations/index.rst +++ b/docs/operations/index.rst @@ -15,5 +15,5 @@ All of the GitHub applications: .. toctree:: :maxdepth: 1 - github_ci_app - github_refresh_app + github-ci-app + github-refresh-app diff --git a/docs/user_guide/flocks.rst b/docs/user-guide/flocks.rst similarity index 100% rename from docs/user_guide/flocks.rst rename to docs/user-guide/flocks.rst diff --git a/docs/user_guide/github/ci.rst b/docs/user-guide/github/ci.rst similarity index 100% rename from docs/user_guide/github/ci.rst rename to docs/user-guide/github/ci.rst diff --git a/docs/user_guide/github/index.rst b/docs/user-guide/github/index.rst similarity index 100% rename from docs/user_guide/github/index.rst rename to docs/user-guide/github/index.rst diff --git a/docs/user_guide/github/refresh.rst b/docs/user-guide/github/refresh.rst similarity index 100% rename from docs/user_guide/github/refresh.rst rename to docs/user-guide/github/refresh.rst diff --git a/docs/user_guide/in_repo_config.rst b/docs/user-guide/in-repo-config.rst similarity index 98% rename from docs/user_guide/in_repo_config.rst rename to docs/user-guide/in-repo-config.rst index 688aef97..88762921 100644 --- a/docs/user_guide/in_repo_config.rst +++ b/docs/user-guide/in-repo-config.rst @@ -38,7 +38,7 @@ Notebook metadata can be edited directly with an editor ("Edit Cell Tags (JSON)" For instance: -.. image:: metadata_example.png +.. image:: metadata-example.png :alt: Editing notebook metadata in JupyterLab :align: center :width: 400px diff --git a/docs/user_guide/index.rst b/docs/user-guide/index.rst similarity index 80% rename from docs/user_guide/index.rst rename to docs/user-guide/index.rst index 8c638f96..ccafadef 100644 --- a/docs/user_guide/index.rst +++ b/docs/user-guide/index.rst @@ -5,6 +5,6 @@ User Guide .. toctree:: flocks - in_repo_config + in-repo-config github/index diff --git a/docs/user_guide/metadata_example.png b/docs/user-guide/metadata-example.png similarity index 100% rename from docs/user_guide/metadata_example.png rename to docs/user-guide/metadata-example.png diff --git a/src/mobu/services/github_ci/ci_notebook_job.py b/src/mobu/services/github_ci/ci_notebook_job.py index fee984ac..53e8e805 100644 --- a/src/mobu/services/github_ci/ci_notebook_job.py +++ b/src/mobu/services/github_ci/ci_notebook_job.py @@ -80,7 +80,7 @@ async def run(self, user: User, scopes: list[str]) -> None: + [ "Note that not all of these may run. Some may be exluded based" " on config in the repo:" - " https://mobu.lsst.io/user_guide/in_repo_config.html" + " https://mobu.lsst.io/user-guide/in-repo-config.html" ] ) await self.check_run.start(summary=summary)