forked from idaholab/magpie
-
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.
Merge pull request idaholab#299 from dschwen/moosedocs_213
Set up moosedocs
- Loading branch information
Showing
43 changed files
with
829 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
Content: | ||
- ${ROOT_DIR}/doc/content | ||
- ${MOOSE_DIR}/framework/doc/content | ||
|
||
Renderer: | ||
type: MooseDocs.base.MaterializeRenderer | ||
name: Magpie | ||
repo: https://github.com/idaholab/magpie | ||
home: https://google.com/ | ||
navigation: | ||
Getting Started: | ||
Installation: 'getting_started/Installation.md' | ||
# Development: | ||
# Capabilities: 'models_capabilities/Capabilities.md' | ||
# Requirements: 'software_quality/Requirements.md' | ||
Documentation: | ||
Reference Manual: documentation/systems/index.md | ||
|
||
Extensions: | ||
appsyntax: | ||
type: MooseDocs.extensions.appsyntax | ||
executable: ${ROOT_DIR} | ||
hide: | ||
magpie: !include ${ROOT_DIR}/doc/hidden.yml | ||
framework: !include ${MOOSE_DIR}/framework/doc/hidden.yml | ||
remove: | ||
framework: !include ${MOOSE_DIR}/framework/doc/remove.yml | ||
globals: | ||
type: MooseDocs.extensions.panoptic | ||
shortcuts: !include ${MOOSE_DIR}/framework/doc/globals.yml | ||
acronyms: | ||
type: MooseDocs.extensions.acronym | ||
acronyms: !include ${MOOSE_DIR}/framework/doc/acronyms.yml |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/AuxKernels/AtomicDensityAux.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# AtomicDensityAux | ||
|
||
!alert construction title=Undocumented Class | ||
The AtomicDensityAux has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /AuxKernels/AtomicDensityAux | ||
|
||
!syntax parameters /AuxKernels/AtomicDensityAux | ||
|
||
!syntax inputs /AuxKernels/AtomicDensityAux | ||
|
||
!syntax children /AuxKernels/AtomicDensityAux | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/AuxKernels/MyTRIMDensityAux.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMDensityAux | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMDensityAux has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /AuxKernels/MyTRIMDensityAux | ||
|
||
!syntax parameters /AuxKernels/MyTRIMDensityAux | ||
|
||
!syntax inputs /AuxKernels/MyTRIMDensityAux | ||
|
||
!syntax children /AuxKernels/MyTRIMDensityAux | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/AuxKernels/MyTRIMElementEnergyAux.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMElementEnergyAux | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMElementEnergyAux has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /AuxKernels/MyTRIMElementEnergyAux | ||
|
||
!syntax parameters /AuxKernels/MyTRIMElementEnergyAux | ||
|
||
!syntax inputs /AuxKernels/MyTRIMElementEnergyAux | ||
|
||
!syntax children /AuxKernels/MyTRIMElementEnergyAux | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/AuxKernels/MyTRIMElementResultAux.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMElementResultAux | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMElementResultAux has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /AuxKernels/MyTRIMElementResultAux | ||
|
||
!syntax parameters /AuxKernels/MyTRIMElementResultAux | ||
|
||
!syntax inputs /AuxKernels/MyTRIMElementResultAux | ||
|
||
!syntax children /AuxKernels/MyTRIMElementResultAux | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/AuxKernels/SPPARKSAux.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# SPPARKSAux | ||
|
||
!alert construction title=Undocumented Class | ||
The SPPARKSAux has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /AuxKernels/SPPARKSAux | ||
|
||
!syntax parameters /AuxKernels/SPPARKSAux | ||
|
||
!syntax inputs /AuxKernels/SPPARKSAux | ||
|
||
!syntax children /AuxKernels/SPPARKSAux | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/DiracKernels/MyTRIMDiracSource.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMDiracSource | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMDiracSource has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /DiracKernels/MyTRIMDiracSource | ||
|
||
!syntax parameters /DiracKernels/MyTRIMDiracSource | ||
|
||
!syntax inputs /DiracKernels/MyTRIMDiracSource | ||
|
||
!syntax children /DiracKernels/MyTRIMDiracSource | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/Kernels/CoupledDefectAnnihilation.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# CoupledDefectAnnihilation | ||
|
||
!alert construction title=Undocumented Class | ||
The CoupledDefectAnnihilation has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Kernels/CoupledDefectAnnihilation | ||
|
||
!syntax parameters /Kernels/CoupledDefectAnnihilation | ||
|
||
!syntax inputs /Kernels/CoupledDefectAnnihilation | ||
|
||
!syntax children /Kernels/CoupledDefectAnnihilation | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/Kernels/DefectAnnihilation.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# DefectAnnihilation | ||
|
||
!alert construction title=Undocumented Class | ||
The DefectAnnihilation has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Kernels/DefectAnnihilation | ||
|
||
!syntax parameters /Kernels/DefectAnnihilation | ||
|
||
!syntax inputs /Kernels/DefectAnnihilation | ||
|
||
!syntax children /Kernels/DefectAnnihilation | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/Kernels/MyTRIMElementHeatSource.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMElementHeatSource | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMElementHeatSource has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Kernels/MyTRIMElementHeatSource | ||
|
||
!syntax parameters /Kernels/MyTRIMElementHeatSource | ||
|
||
!syntax inputs /Kernels/MyTRIMElementHeatSource | ||
|
||
!syntax children /Kernels/MyTRIMElementHeatSource | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/Kernels/MyTRIMElementSource.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMElementSource | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMElementSource has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Kernels/MyTRIMElementSource | ||
|
||
!syntax parameters /Kernels/MyTRIMElementSource | ||
|
||
!syntax inputs /Kernels/MyTRIMElementSource | ||
|
||
!syntax children /Kernels/MyTRIMElementSource | ||
|
||
!bibtex bibliography |
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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMMesh | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMMesh has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Mesh/MyTRIMMesh | ||
|
||
!syntax parameters /Mesh/MyTRIMMesh | ||
|
||
!syntax inputs /Mesh/MyTRIMMesh | ||
|
||
!syntax children /Mesh/MyTRIMMesh | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/Postprocessors/IsotopeRecoilRate.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# IsotopeRecoilRate | ||
|
||
!alert construction title=Undocumented Class | ||
The IsotopeRecoilRate has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Postprocessors/IsotopeRecoilRate | ||
|
||
!syntax parameters /Postprocessors/IsotopeRecoilRate | ||
|
||
!syntax inputs /Postprocessors/IsotopeRecoilRate | ||
|
||
!syntax children /Postprocessors/IsotopeRecoilRate | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/Postprocessors/MyTRIMPKAInConeInfo.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMPKAInConeInfo | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMPKAInConeInfo has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Postprocessors/MyTRIMPKAInConeInfo | ||
|
||
!syntax parameters /Postprocessors/MyTRIMPKAInConeInfo | ||
|
||
!syntax inputs /Postprocessors/MyTRIMPKAInConeInfo | ||
|
||
!syntax children /Postprocessors/MyTRIMPKAInConeInfo | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/Postprocessors/MyTRIMPKAInfo.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMPKAInfo | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMPKAInfo has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Postprocessors/MyTRIMPKAInfo | ||
|
||
!syntax parameters /Postprocessors/MyTRIMPKAInfo | ||
|
||
!syntax inputs /Postprocessors/MyTRIMPKAInfo | ||
|
||
!syntax children /Postprocessors/MyTRIMPKAInfo | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/Transfers/MultiAppNeutronicsSpectrumTransfer.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MultiAppNeutronicsSpectrumTransfer | ||
|
||
!alert construction title=Undocumented Class | ||
The MultiAppNeutronicsSpectrumTransfer has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /Transfers/MultiAppNeutronicsSpectrumTransfer | ||
|
||
!syntax parameters /Transfers/MultiAppNeutronicsSpectrumTransfer | ||
|
||
!syntax inputs /Transfers/MultiAppNeutronicsSpectrumTransfer | ||
|
||
!syntax children /Transfers/MultiAppNeutronicsSpectrumTransfer | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/UserObjects/ElasticRecoil.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# ElasticRecoil | ||
|
||
!alert construction title=Undocumented Class | ||
The ElasticRecoil has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /UserObjects/ElasticRecoil | ||
|
||
!syntax parameters /UserObjects/ElasticRecoil | ||
|
||
!syntax inputs /UserObjects/ElasticRecoil | ||
|
||
!syntax children /UserObjects/ElasticRecoil | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/UserObjects/InelasticRecoil.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# InelasticRecoil | ||
|
||
!alert construction title=Undocumented Class | ||
The InelasticRecoil has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /UserObjects/InelasticRecoil | ||
|
||
!syntax parameters /UserObjects/InelasticRecoil | ||
|
||
!syntax inputs /UserObjects/InelasticRecoil | ||
|
||
!syntax children /UserObjects/InelasticRecoil | ||
|
||
!bibtex bibliography |
19 changes: 19 additions & 0 deletions
19
doc/content/documentation/systems/UserObjects/MyTRIMDiracRun.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,19 @@ | ||
<!-- MOOSE Documentation Stub: Remove this when content is added. --> | ||
|
||
# MyTRIMDiracRun | ||
|
||
!alert construction title=Undocumented Class | ||
The MyTRIMDiracRun has not been documented, if you would like to contribute to MOOSE by | ||
writing documentation, please see [/generate.md]. The content contained on this page explains | ||
the typical documentation associated with a MooseObject; however, what is contained is ultimately | ||
determined by what is necessary to make the documentation clear for users. | ||
|
||
!syntax description /UserObjects/MyTRIMDiracRun | ||
|
||
!syntax parameters /UserObjects/MyTRIMDiracRun | ||
|
||
!syntax inputs /UserObjects/MyTRIMDiracRun | ||
|
||
!syntax children /UserObjects/MyTRIMDiracRun | ||
|
||
!bibtex bibliography |
Oops, something went wrong.