Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
4 changes: 4 additions & 0 deletions docs/requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinx==8.0.0
sphinx_rtd_theme>=3.0.0
sphinxcontrib-bibtex>=2.6.4
setuptools<81.0.0
80 changes: 77 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,77 @@
sphinxcontrib-bibtex
sphinx_rtd_theme
docutils==0.16
#
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile --output-file=docs/requirements.txt docs/requirements.in
#
alabaster==1.0.0
# via sphinx
babel==2.18.0
# via sphinx
certifi==2026.2.25
# via requests
charset-normalizer==3.4.4
# via requests
colorama==0.4.6
# via sphinx
docutils==0.21.2
# via
# pybtex-docutils
# sphinx
# sphinx-rtd-theme
# sphinxcontrib-bibtex
idna==3.11
# via requests
imagesize==2.0.0
# via sphinx
jinja2==3.1.6
# via sphinx
latexcodec==3.0.1
# via pybtex
markupsafe==3.0.3
# via jinja2
packaging==26.0
# via sphinx
pybtex==0.25.1
# via
# pybtex-docutils
# sphinxcontrib-bibtex
pybtex-docutils==1.0.3
# via sphinxcontrib-bibtex
pygments==2.19.2
# via sphinx
pyyaml==6.0.3
# via pybtex
requests==2.32.5
# via sphinx
snowballstemmer==3.0.1
# via sphinx
sphinx==8.0.0
# via
# -r docs/requirements.in
# sphinx-rtd-theme
# sphinxcontrib-bibtex
# sphinxcontrib-jquery
sphinx-rtd-theme==3.1.0
# via -r docs/requirements.in
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-bibtex==2.6.5
# via -r docs/requirements.in
sphinxcontrib-devhelp==2.0.0
# via sphinx
sphinxcontrib-htmlhelp==2.1.0
# via sphinx
sphinxcontrib-jquery==4.1
# via sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
urllib3==2.6.3
# via requests

# The following packages are considered to be unsafe in a requirements file:
# setuptools
9 changes: 8 additions & 1 deletion docs/source/Container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,16 @@ These instructions will help users build and run a basic case for the Unified Fo

The out-of-the-box Land DA case described in this User's Guide builds a weather forecast for January 1, 2016 at 18z to January 3, 2016 at 18z.

.. warning::

Container links on this page may not work. For assistance, please reach out to NOAA EPIC support:

* **Email:** `support.epic@noaa.gov <mailto:support.epic@noaa.gov>`__
* **Discussions:** `Land DA Q&A on GitHub <https://github.com/ufs-community/land-DA_workflow/discussions/categories/q-a>`__

.. attention::

This chapter of the User's Guide should **only** be used for container builds. For non-container builds, see :numref:`Chapter %s <BuildRunLandDA>`, which describes the steps for building and running Land DA on a :ref:`Level 1 System <LevelsOfSupport>` **without** a container.
This chapter of the User's Guide should **only** be used for container builds. For non-container builds, see :numref:`Chapter %s <BuildRunLandDA>`, which describes the steps for building and running Land DA on a :ref:`Level 1 System <LevelsOfSupport>` **without** a container.

.. _Prereqs:

Expand Down
Loading