Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor documentation fixes #505

Merged
merged 4 commits into from
Sep 30, 2024
Merged

minor documentation fixes #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
64b057e
fix incorrect language setting in sphinx documentation build
edwardhartnett Sep 30, 2024
37f3d16
changed name of branch in documentation to main
edwardhartnett Sep 30, 2024
01892ae
turned on warnings as errors in doc build
edwardhartnett Sep 30, 2024
13529a4
Merge branch 'main' into ejh_doc_093024
MatthewPyle-NOAA Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
- name: Build docs
run: |
cd rrfs-workflow/doc/UsersGuide
sphinx-build -b html source build
sphinx-build -W --keep-going source build
- uses: actions/upload-artifact@v4
with:
name: rrfs-workflow docs
Expand Down
4 changes: 2 additions & 2 deletions doc/UsersGuide/source/Quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ This chapter provides a brief summary of how to build and run the RRFS-Workflow.
Building RRFS workflow
===============================================

#. Clone the ``dev-sci`` branch of the RRFS-Workflow from GitHub:
#. Clone the ``main`` branch of the RRFS-Workflow from GitHub:

.. code-block:: console

git clone -b dev-sci https://github.com/NOAA-EMC/rrfs-workflow.git
git clone https://github.com/NOAA-EMC/rrfs-workflow.git

#. Check out the external components:

Expand Down
2 changes: 1 addition & 1 deletion doc/UsersGuide/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
Loading