From 7801831e6402eecfc70b736bff387b44ccc0183d Mon Sep 17 00:00:00 2001 From: Matthew Hoffman Date: Thu, 30 Nov 2023 16:27:49 -0700 Subject: [PATCH 1/2] Add info about viewing compiled docs via www at NERSC --- docs/developers_guide/building_docs.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/developers_guide/building_docs.rst b/docs/developers_guide/building_docs.rst index e79c5dbb3d..ffb233cd5d 100644 --- a/docs/developers_guide/building_docs.rst +++ b/docs/developers_guide/building_docs.rst @@ -23,3 +23,11 @@ script was last sourced. The load script will reinstall compass into the conda environment when it is sourced in the root of the compass branch. You can view the documentation by opening ``_build/html/index.html``. +From any machine, you can scp the ``html`` directory to your local computer for +viewing. +On NERSC, you can conveniently make use of their +`web Science Gateway `_ +to avoid transferring data. By copying your compiled documentation to +an appropriately named subdirectory at +``/global/cfs/cdirs/myproj/www``, it can then be viewed from a browser at +``https://portal.nersc.gov/cfs/myproj/``. From fd9e5db3b428977c19f19ae0e14c9504ef3556a4 Mon Sep 17 00:00:00 2001 From: Matt Hoffman Date: Wed, 17 Jan 2024 19:54:34 -0700 Subject: [PATCH 2/2] Update docs/developers_guide/building_docs.rst add info regarding chmod command and info for LCRC Co-authored-by: Xylar Asay-Davis --- docs/developers_guide/building_docs.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/developers_guide/building_docs.rst b/docs/developers_guide/building_docs.rst index ffb233cd5d..a2c78a7f6b 100644 --- a/docs/developers_guide/building_docs.rst +++ b/docs/developers_guide/building_docs.rst @@ -25,9 +25,15 @@ environment when it is sourced in the root of the compass branch. You can view the documentation by opening ``_build/html/index.html``. From any machine, you can scp the ``html`` directory to your local computer for viewing. + On NERSC, you can conveniently make use of their `web Science Gateway `_ to avoid transferring data. By copying your compiled documentation to an appropriately named subdirectory at -``/global/cfs/cdirs/myproj/www``, it can then be viewed from a browser at -``https://portal.nersc.gov/cfs/myproj/``. +``/global/cfs/cdirs//www/`` and then running ``chmod -R ugo+rX .`` on that directory +(and perhaps its parent directories), it can then be viewed from a browser at +``https://portal.nersc.gov/cfs//``. + +LCRC also has a web portal. You can copy the compiled documentation to a subdirectory in +``/lcrc/group/e3sm/public_html/diagnostic_output//``. Then, you can +view it at ``https://web.lcrc.anl.gov/public/e3sm/diagnostic_output//``