Skip to content

Commit

Permalink
updating all headers for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
lisagoodrich authored Oct 3, 2023
1 parent ee0f471 commit c4af380
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions docs/Contributors_Guide/documentation.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
*************
Documentation
=============
*************

Viewing METplus documentation
_____________________________
=============================

The METplus documentation (beginning with version 3.0) is available
`online <https://metplus.readthedocs.io/>`_.


Doxygen Source Code Documentation
_________________________________
=================================

The source code documentation is coming soon.


Documentation Overview
______________________
======================

The majority of the documentation is created using the Sphinx documentation
generator tool, which was originally created for Python documentation.
Expand All @@ -37,7 +38,7 @@ Contributor's Guide.


Description of Documentation Directories
________________________________________
========================================

Core documentation is divided into four sections: User's Guide, Contributor's
Guide, Release Guide, and Verification Datasets Guide all of which reside
Expand All @@ -61,7 +62,7 @@ section for more information on documenting a new use case.


Adding New Documentation
________________________
========================

To determine where to add new documentation:

Expand All @@ -81,7 +82,7 @@ To determine where to add new documentation:


User's Guide:
~~~~~~~~~~~~~
-------------

* To add/modify any content that affects METplus users.
* Modify any of the affected sections from the
Expand All @@ -94,7 +95,7 @@ User's Guide:
* **wrappers.rst** (METplus wrappers)

Contributor's Guide:
~~~~~~~~~~~~~~~~~~~~
--------------------

* To add/modify any content that affects METplus contributors.
* Modify any of the affected sections from the
Expand All @@ -118,7 +119,7 @@ Contributor's Guide:
wrapper code)

Release Guide:
~~~~~~~~~~~~~~
--------------

* To add/modify the instructions for creating software releases for
any METplus component, including official, bugfix, and development
Expand Down Expand Up @@ -154,7 +155,7 @@ Release Guide:


Verification Datasets Guide:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
----------------------------

* To add/modify any relevant datasets in an attempt to create a
centralized catalog of verification datasets to provide the model
Expand All @@ -165,7 +166,7 @@ Verification Datasets Guide:
.. _read-the-docs:

Read the Docs METplus Documentation
___________________________________
===================================

The METplus components use `Read the Docs <https://docs.readthedocs.io/>`_ to
build and display the documentation. Read the Docs simplifies the
Expand Down Expand Up @@ -217,7 +218,7 @@ Documentation for each METplus component can be found at the links below:


Building Sphinx Documentation Manually
______________________________________
======================================

Documentation does not have to be built manually as it is automatically
generated by Read The Docs. See the
Expand Down Expand Up @@ -259,7 +260,7 @@ will direct to the home page of the documentation. Click on the links to
navigate to the desired information.

Relevant Documentation for Contributors
_______________________________________
=======================================

The Doxygen tool is employed to create documentation from the source code.
This documentation is useful in generating details about the METplus wrapper
Expand Down

0 comments on commit c4af380

Please sign in to comment.