Skip to content

Commit

Permalink
Update docs/developers_guide/building_docs.rst
Browse files Browse the repository at this point in the history
add info regarding chmod command and info for LCRC

Co-authored-by: Xylar Asay-Davis <[email protected]>
  • Loading branch information
matthewhoffman and xylar committed Jan 18, 2024
1 parent 7801831 commit fd9e5db
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/developers_guide/building_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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``, it can then be viewed from a browser at
``https://portal.nersc.gov/cfs/myproj/``.
``/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 fd9e5db

Please sign in to comment.