Skip to content

Commit

Permalink
Add links to API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sayerhs committed Jul 11, 2020
1 parent 06e08a3 commit cbd40c2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AMR-Wind

[Website](https://www.exawind.org/) | [Documentation](https://amr-wind.readthedocs.io) | [Nightly test dashboard](http://my.cdash.org/index.php?project=AMR-Wind)
[Website](https://www.exawind.org/) | [User manual](https://amr-wind.readthedocs.io) | [API docs](https://exawind.github.io/amr-wind/index.html) | [Nightly test dashboard](http://my.cdash.org/index.php?project=AMR-Wind)

[![Powered by AMReX](https://amrex-codes.github.io/badges/powered%20by-AMReX-red.svg)](https://amrex-codes.github.io/amrex/) [![Build Status](https://github.com/Exawind/amr-wind/workflows/AMR-Wind-CI/badge.svg)](https://github.com/Exawind/amr-wind/actions) [![Docs Status](https://readthedocs.org/projects/pip/badge/?version=latest)](https://amr-wind.readthedocs.io)

Expand Down
25 changes: 20 additions & 5 deletions docs/sphinx_doc/dev/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,29 @@ provides an overview of this format and how to write documentation using this fo


Documenting source code
-----------------------
-------------------------

Source code (C++ files) are commented using a special format that allows Doxygen
to extract the annotated comments and create source code documentation as well
as inheritance diagrams. `Doxygen manual
<http://www.doxygen.nl/manual/index.html>`_ provides an overview of the syntax
that must be used. Please follow the Doxygen style of commenting code when
commenting AMR-Wind sources.
as inheritance diagrams. API documentation for the latest snapshot of the
codebase can be browsed online `here
<https://exawind.github.io/amr-wind/index.html>`_. To build the documentation
locally, first install ``doxygen`` and ``graphviz`` executables on your system.
Once they are successfully installed, execute the following command from the
root directory of ``amr-wind``

.. code-block:: console
doxygen ./docs/doxygen/Doxyfile
The default format is HTML, and upon successful completion of the above command,
the documentation files are available in :file:`build/html` directory. Open
:file:`build/html/index.html` on your browser to browse the locally generated
documentation.

`Doxygen manual <http://www.doxygen.nl/manual/index.html>`_ provides an overview
of the syntax that must be used. Please follow the Doxygen style of commenting
code when commenting AMR-Wind sources.

When commenting code, try to use self-documenting code, i.e., descriptive names
for variables and functions that eliminate the need to describe what is going on
Expand Down

0 comments on commit cbd40c2

Please sign in to comment.