From 225540b391515d72f56c9b62f752a5f79f1cb531 Mon Sep 17 00:00:00 2001 From: Bill Sacks Date: Sun, 13 Sep 2020 15:28:11 -0600 Subject: [PATCH] Add version information on the top of every page Ryan Johnson suggested this so that the version information is obvious no matter which page you land on. --- doc/source/cesm_configurations.rst | 6 +++--- doc/source/conf.py | 4 ++-- doc/source/downloading_cesm.rst | 6 +++--- doc/source/index.rst | 4 ++-- doc/source/introduction.rst | 6 +++--- doc/source/quickstart.rst | 6 +++--- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/source/cesm_configurations.rst b/doc/source/cesm_configurations.rst index 8e174c1b0f..e859914fca 100644 --- a/doc/source/cesm_configurations.rst +++ b/doc/source/cesm_configurations.rst @@ -1,8 +1,8 @@ .. _configurations: -====================== - CESM2 Configurations -====================== +=============================== +CESM Configurations (|version|) +=============================== The CESM system can be configured a number of different ways from both a science and technical perspective. CESM supports numerous diff --git a/doc/source/conf.py b/doc/source/conf.py index 3e9410c478..0ac55316d6 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -64,9 +64,9 @@ # built documents. # # The short X.Y version. -version = u'CESM Latest Development Code' +version = u'Latest Development Code' # The full version, including alpha/beta/rc tags. -release = u'CESM Latest Development Code' +release = u'Latest Development Code' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/source/downloading_cesm.rst b/doc/source/downloading_cesm.rst index b654292083..1c7586df0f 100644 --- a/doc/source/downloading_cesm.rst +++ b/doc/source/downloading_cesm.rst @@ -1,8 +1,8 @@ .. _downloading: -======================= - Downloading |version| -======================= +============================ +Downloading CESM (|version|) +============================ Downloading the code and scripts -------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 1db8fc547d..e7dc248f37 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -|version| Quickstart Guide -========================== +CESM Quickstart Guide (|version|) +================================= .. important:: **There are separate versions of this documentation for each maintained CESM diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst index 7d2a591756..cc8929006b 100644 --- a/doc/source/introduction.rst +++ b/doc/source/introduction.rst @@ -1,8 +1,8 @@ .. _introduction: -============== - Introduction -============== +======================== +Introduction (|version|) +======================== How To Use This Document ------------------------ diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index e8b424ff43..a1cd59dc7e 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -1,8 +1,8 @@ .. _quickstart: -==================================== - Quick Start (CESM2 Model Workflow) -==================================== +============================================ +Quick Start: CESM Model Workflow (|version|) +============================================ The following quick start guide is for versions of CESM2 that have already been ported to the local target machine. CESM2 is built on the