Skip to content

Commit

Permalink
minor documentation fixes (#505)
Browse files Browse the repository at this point in the history
* fix incorrect language setting in sphinx documentation build
* changed name of branch in documentation to main
* turned on warnings as errors in doc build
---------
  • Loading branch information
edwardhartnett authored Sep 30, 2024
1 parent ff90de0 commit b29e9d4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
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
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
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

0 comments on commit b29e9d4

Please sign in to comment.