From dd126f039ea69250646ef4ebb02888c8961a7133 Mon Sep 17 00:00:00 2001 From: William Hobbs Date: Wed, 23 Oct 2024 16:11:35 -0700 Subject: [PATCH 1/2] docs: fix broken links Problem: there are a lot of broken links in our docs. Fix them. --- conf.py | 4 ++++ faqs.rst | 2 +- jobs/batch.rst | 7 +++++-- jobs/debugging.rst | 8 ++++---- quickstart.rst | 2 +- 5 files changed, 15 insertions(+), 8 deletions(-) diff --git a/conf.py b/conf.py index 6bada58b..3483a242 100644 --- a/conf.py +++ b/conf.py @@ -367,3 +367,7 @@ def setup(app): objname="configuration value", indextemplate="pair: %s; configuration value", ) + +linkcheck_ignore = [ + r'https://github.com/flux-framework/flux-core\?tab\=readme-ov-file\#build-requirements' +] diff --git a/faqs.rst b/faqs.rst index 795235a8..77a104ba 100644 --- a/faqs.rst +++ b/faqs.rst @@ -302,7 +302,7 @@ may help improve efficiency and throughput: - If scripting ``flux submit`` commands, avoid the pattern of one command per job as each command invocation has a startup cost. Instead try to combine similar job submissions with ``flux submit --cc=IDSET`` - or :core:man1:`flux-builksubmit`. + or :core:man1:`flux-bulksubmit`. - By default ``flux submit --cc=IDSET`` and ``flux bulksubmit`` will exit once all jobs have been submitted. To wait for all jobs to complete before proceeding, use the ``--wait`` or ``--watch`` options to diff --git a/jobs/batch.rst b/jobs/batch.rst index eb24fb67..6284e6a2 100644 --- a/jobs/batch.rst +++ b/jobs/batch.rst @@ -7,8 +7,11 @@ Batch Jobs In Flux, a batch job is a script submitted along with a request for resources. When resources become available, the script is run as the -`initial program `_ of a new single-user instance of Flux, -with the batch user as `instance owner `_. +`initial program +`_ +of a new single-user instance of Flux, +with the batch user as `instance owner +`_. Thus, in contrast to a traditional batch scheduler, a Flux batch job has access to fully featured resource manager instance, and may not only serially execute work on allocated resources, but load custom modules diff --git a/jobs/debugging.rst b/jobs/debugging.rst index 9fd5ce63..f57cdfdc 100644 --- a/jobs/debugging.rst +++ b/jobs/debugging.rst @@ -6,7 +6,7 @@ Debugging Jobs Debugging Flux jobs has been tested with Rogue Wave Software (RWS)'s `TotalView parallel debugger `_ and -Linaro `DDT `_. More detailed +Linaro `DDT `_. More detailed instructions for specific debuggers are included in the sections below. ---------------------------------- @@ -102,7 +102,7 @@ Parallel Debugging with DDT While at this time DDT does not have native support for Flux, small to medium size jobs can be debugged with DDT using a combination of the -:core:man1:`flux job` :command:`hostpids` command and the :command:`ddt +:core:man1:`flux-job` :command:`hostpids` command and the :command:`ddt --attach` option. For example, to attach :command:`ddt` to the previous job @@ -110,7 +110,7 @@ job $ ddt --attach=$(flux job hostpids $(flux job last)) -Flux can launch jobs with every task stopped in :linux:man2:`exec` by +Flux can launch jobs with every task stopped in :linux:man3:`exec` by providing the ``stop-tasks-in-exec`` job shell option. Thus, launching a job under control of DDT can be simulated by something like: @@ -121,7 +121,7 @@ job under control of DDT can be simulated by something like: The :command:`flux job hostpids` command will block until the job has started running and the process IDs for all tasks are available, and therfore :command:`ddt` will not launch until the job has started and is ready -for debugger attach. Since tasks have been stopped in :linux:man2:`exec`, +for debugger attach. Since tasks have been stopped in :linux:man3:`exec`, the debugger will have control of job tasks before execution begins. .. note:: diff --git a/quickstart.rst b/quickstart.rst index 2ff59c7a..cddd6175 100644 --- a/quickstart.rst +++ b/quickstart.rst @@ -120,7 +120,7 @@ Manual Installation Recommended for developers and contributors Ensure the latest list of requirements are installed. The -current list of build requirements are detailed `here `_. +current list of build requirements are detailed `here `_. Clone current flux-core master: From 34da17f8ab7da2f229d92379322bff70614d3d51 Mon Sep 17 00:00:00 2001 From: William Hobbs Date: Thu, 24 Oct 2024 16:23:18 -0700 Subject: [PATCH 2/2] github: run linkcheck in workflow Problem: our links have become stale due to not enforcing sphinx's linkcheck option in CI. Add that back in. Fixes #284 --- .github/workflows/main.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1adc4b50..8d4f1623 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -30,7 +30,7 @@ jobs: echo "Testing that you built the auto-examples, if this fails run flux start make html locally." python .github/scripts/check_diff.py /tmp/auto_examples ./auto_examples - spelling: + spell-and-linkcheck: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 @@ -44,3 +44,6 @@ jobs: uses: crate-ci/typos@7ad296c72fa8265059cc03d1eda562fbdfcd6df2 # v1.9.0 with: files: "*.rst */*.rst */*/*.rst" + + - name: make linkcheck + run: make linkcheck