From 4c29b61175d0ebfca294b32eab5304c916334cdc Mon Sep 17 00:00:00 2001 From: Fred Hornsey Date: Tue, 2 Jul 2024 17:18:57 -0500 Subject: [PATCH] Fix News and Move Linkcheck to a Seperate Job Fixes #4713 --- .github/workflows/sphinx_strict.yml | 14 ++++++++++++-- docs/build.py | 3 +++ docs/news.d/resend_period_fractions_seconds.rst | 2 +- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/.github/workflows/sphinx_strict.yml b/.github/workflows/sphinx_strict.yml index 5ff39af3c29..a0c95a94e94 100644 --- a/.github/workflows/sphinx_strict.yml +++ b/.github/workflows/sphinx_strict.yml @@ -1,4 +1,4 @@ -name: sphinx_strict +name: Sphinx Tests on: push: @@ -7,7 +7,7 @@ on: - cron: '0 1 * * SUN' jobs: - build: + strict: runs-on: ubuntu-latest steps: - name: checkout OpenDDS @@ -16,3 +16,13 @@ jobs: - name: Run Strict Checks run: | python3 docs/build.py strict + + linkcheck: + runs-on: ubuntu-latest + steps: + - name: checkout OpenDDS + uses: actions/checkout@v4 + + - name: Run Link Checks + run: | + python3 docs/build.py linkcheck diff --git a/docs/build.py b/docs/build.py index 4df22267a48..661c0e28c36 100755 --- a/docs/build.py +++ b/docs/build.py @@ -119,6 +119,9 @@ def do_test(self): def do_strict(self): self.do(['test'], because_of='strict') self.sphinx_build('dummy', '-W') + return None + + def do_linkcheck(self): self.sphinx_build('linkcheck', defines=['gen_all_omg_spec_links=False']) return None diff --git a/docs/news.d/resend_period_fractions_seconds.rst b/docs/news.d/resend_period_fractions_seconds.rst index 0e1058fd240..e475792609e 100644 --- a/docs/news.d/resend_period_fractions_seconds.rst +++ b/docs/news.d/resend_period_fractions_seconds.rst @@ -1,5 +1,5 @@ .. news-prs: 4712 .. news-start-section: Additions -- :prop:`[rtps_discovery]ResendPeriod` now accepts fractions of a second. +- :cfg:prop:`[rtps_discovery]ResendPeriod` now accepts fractions of a second. .. news-end-section