forked from idaholab/mastodon
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added developer manual and instructions for documentation.
Refs #3 and idaholab#156.
- Loading branch information
1 parent
0ba7b3d
commit b69be20
Showing
3 changed files
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Developer Manual | ||
|
||
!include include/developer/documentation.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
## Instructions for documentation | ||
|
||
Prior to merging the code, MOOSE and MASTODON require adequate documentation | ||
describing the implemented feature, such as materials, post processors, etc. | ||
Several tools are available for MOOSE-based documentation, and these tools are | ||
described [here](utilities/MooseDocs/index.md). | ||
For each new feature, the following documentation files are required. | ||
|
||
#### Documentation of C++ objects | ||
|
||
For each C++ object created, the developer should include the documentation as | ||
prescribed by [MOOSE requirements](utilities/MooseDocs/generate.md). | ||
|
||
#### User manual | ||
|
||
For each feature (such as material, boundary condition, etc., which may include | ||
one of more C++ objects), the developer must create one documentation file that | ||
describes the method of usage of this feature. This file must be named as | ||
`<feature_name>-user.md` and be placed in the appropriate sub folder in | ||
`content/manuals/include`. A rough template for the user manual document is | ||
below. | ||
|
||
``` | ||
# <Name of the feature, e.g., lead-rubber isolator> | ||
Introduction and link to the corresponding theory manual document. | ||
Objects needed to simulate this feature. Links to the documentation of these | ||
objects. | ||
Associated actions, and usage in the Mastodon block, if available. Link to the | ||
documentation of the corresponding Mastodon block action. | ||
Quick demo of this feature including listings of input files and sample results. | ||
``` | ||
|
||
#### Theory manual | ||
|
||
For each feature (such as material, boundary condition, etc., which may include | ||
one of more C++ objects), the developer must create one documentation file that | ||
describes the theory behind this feature. This file must be named as | ||
`<feature_name>-theory.md` and be placed in the appropriate sub folder in | ||
`content/manuals/include`. A rough template for the theory manual document is | ||
below. | ||
|
||
``` | ||
# <Name of the feature, e.g., lead-rubber isolator> | ||
Introduction about what the feature does and a link to the corresponding user | ||
manual document. | ||
Description of the physics, or the theory behind the feature including | ||
references, equations, figures, etc. | ||
Limitations, if any, of the implementation of this feature in MASTODON. | ||
``` |