Skip to content

Commit

Permalink
Merge pull request #740 from matthewhoffman/docs/nersc_www
Browse files Browse the repository at this point in the history
Add info about viewing compiled docs via www at NERSC

This merge adds information about how to view compiled documentation via NERSC's web Science Gateway to avoid needing to scp the compiled documentation locally.
  • Loading branch information
matthewhoffman authored Jan 19, 2024
2 parents a2a9579 + fd9e5db commit 5fb7b4f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/developers_guide/building_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,17 @@ 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 <https://docs.nersc.gov/services/science-gateways/#web-methods-for-data>`_
to avoid transferring data. By copying your compiled documentation to
an appropriately named subdirectory at
``/global/cfs/cdirs/<myproj>/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/<myproj>/``.

LCRC also has a web portal. You can copy the compiled documentation to a subdirectory in
``/lcrc/group/e3sm/public_html/diagnostic_output/<username>/``. Then, you can
view it at ``https://web.lcrc.anl.gov/public/e3sm/diagnostic_output/<username>/``

0 comments on commit 5fb7b4f

Please sign in to comment.