Skip to content

Commit

Permalink
Merge pull request #19 from JulieSchramm/release/public-v4
Browse files Browse the repository at this point in the history
Update documentation for doxygen on Hera
  • Loading branch information
ligiabernardet authored Mar 9, 2020
2 parents 690096f + b7533a2 commit 857685f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions CCPPtechnical/source/ScientificDocRules.inc
Original file line number Diff line number Diff line change
Expand Up @@ -566,10 +566,12 @@ Using Doxygen

In order to generate the doxygen-based documentation, one needs to follow five steps:

#. Have the doxygen executable installed on your computer. For example, for the NOAA
machine Theia, add the following line into ``.cshrc`` file in your home directory:
#. Have the doxygen executable installed on your computer. For the NOAA
machine Hera and the NCAR machine Cheyenne, the doxygen executable resides in ``/usr/bin``,
which should be in your ``$PATH``. If you need to install doxygen in another location, add
the following line into the ``.cshrc`` file in your home directory:

``alias doxygen /scratch4/BMC/gmtb/doxygen-1.8.10/bin/doxygen``
``alias doxygen /path/to/doxygen``

Source your ``.cshrc`` file.

Expand Down
2 changes: 1 addition & 1 deletion CCPPtechnical/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
contain the root `toctree` directive.
CCPP v4 Technical Documentation
============================
===============================

.. toctree::
:numbered:
Expand Down

0 comments on commit 857685f

Please sign in to comment.