Skip to content

Commit

Permalink
Add info about viewing compiled docs via www at NERSC
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewhoffman committed Nov 30, 2023
1 parent cebf950 commit 7801831
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/developers_guide/building_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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/``.

0 comments on commit 7801831

Please sign in to comment.