From 9fb0c76c38b943356c1d377c30c07afe90d47289 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Thu, 21 Nov 2024 11:40:29 -0500 Subject: [PATCH 1/6] Adding the base model component documentation now that it is available. --- .github/workflows/documentation.yml | 9 +++++---- tox.ini | 4 ++++ 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index b741362d..3aef2878 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -7,6 +7,8 @@ on: # Runs on pushes targeting the default branch push: branches: ["main"] + pull_request: + branches: ["main"] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -25,9 +27,7 @@ concurrency: jobs: build: - runs-on: ubuntu-latest - steps: - name: Checkout uses: actions/checkout@v4 @@ -51,11 +51,12 @@ jobs: # Deployment job deploy: + runs-on: ubuntu-latest + needs: build + if: github.event_name == 'push' && github.ref == 'refs/heads/main' # Only run on pushes to main environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - needs: build steps: - name: Deploy to GitHub Pages id: deployment diff --git a/tox.ini b/tox.ini index af2c7b03..fc8a4f4a 100644 --- a/tox.ini +++ b/tox.ini @@ -117,9 +117,13 @@ commands = basepython = python3 changedir={toxinidir}/docs extras = docs +deps = + firewheel-repo-base allowlist_externals= /usr/bin/make + /bin/mkdir commands = + mkdir -p source/model_components make html all: make singlehtml all: sphinx-build -M man source/cli build -c source From 53712abf79c7852e2ca6bbfe17f262d3994dbc10 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Thu, 21 Nov 2024 11:50:55 -0500 Subject: [PATCH 2/6] Allowing a new directory to be created --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index fc8a4f4a..26f45da1 100644 --- a/tox.ini +++ b/tox.ini @@ -123,8 +123,8 @@ allowlist_externals= /usr/bin/make /bin/mkdir commands = - mkdir -p source/model_components - make html + /bin/mkdir -p source/model_components + /usr/bin/make html all: make singlehtml all: sphinx-build -M man source/cli build -c source all: make latexpdf From 86c2c12a4c20d1dfe72e7f0912f6dca09be8c6e7 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Thu, 21 Nov 2024 12:16:42 -0500 Subject: [PATCH 3/6] Fixing a bug with the version introduced by #14 --- docs/source/conf.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d228736f..e03d49ef 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,11 +13,10 @@ import sys import importlib.util from pathlib import Path -from importlib.metadata import metadata +from importlib.metadata import metadata, version import sphinx_rtd_theme # noqa: F401 -import firewheel from firewheel.control.repository_db import RepositoryDb from firewheel.control.model_component_manager import ModelComponentManager from firewheel.control.model_component_iterator import ModelComponentIterator @@ -33,10 +32,10 @@ author = "Sandia National Laboratories" # The short X.Y version -version = firewheel.__version__ +version = version("firewheel") # The full version, including alpha/beta/rc tags -release = firewheel.__version__ +release = version("firewheel") # -- General configuration --------------------------------------------------- From bb28e48bc70088a62bd039ac86d6100dff84a961 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Thu, 21 Nov 2024 12:20:18 -0500 Subject: [PATCH 4/6] Fixing a conflict with variable names --- docs/source/conf.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index e03d49ef..9c78a74d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,7 +13,8 @@ import sys import importlib.util from pathlib import Path -from importlib.metadata import metadata, version +from importlib.metadata import version as importlib_version +from importlib.metadata import metadata import sphinx_rtd_theme # noqa: F401 @@ -32,10 +33,10 @@ author = "Sandia National Laboratories" # The short X.Y version -version = version("firewheel") +version = importlib_version("firewheel") # The full version, including alpha/beta/rc tags -release = version("firewheel") +release = importlib_version("firewheel") # -- General configuration --------------------------------------------------- From 4981cd2a70b116db330799d5efc40508d285b520 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Mon, 16 Dec 2024 15:56:47 -0500 Subject: [PATCH 5/6] Adding more available repositories --- tox.ini | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tox.ini b/tox.ini index 26f45da1..05a7d2a2 100644 --- a/tox.ini +++ b/tox.ini @@ -119,6 +119,11 @@ changedir={toxinidir}/docs extras = docs deps = firewheel-repo-base + firewheel-repo-linux + firewheel-repo-tutorials + firewheel-repo-layer2 + firewheel-repo-ntp + firewheel-repo-dns allowlist_externals= /usr/bin/make /bin/mkdir From da778a969c475ac10d096c3c193cdf94af4919b1 Mon Sep 17 00:00:00 2001 From: Steven Elliott Date: Mon, 16 Dec 2024 16:13:11 -0500 Subject: [PATCH 6/6] Adding the VyOS model component repo --- tox.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/tox.ini b/tox.ini index 05a7d2a2..3d85bfc8 100644 --- a/tox.ini +++ b/tox.ini @@ -120,6 +120,7 @@ extras = docs deps = firewheel-repo-base firewheel-repo-linux + firewheel-repo-vyos firewheel-repo-tutorials firewheel-repo-layer2 firewheel-repo-ntp