From d15dc0c57397ef0b9051c18cefa32be49d8836aa Mon Sep 17 00:00:00 2001
From: Sun Myung Park <park_cg@live.com>
Date: Fri, 29 Oct 2021 16:11:48 -0500
Subject: [PATCH 1/2] Add files to set up MooseDocs
---
doc/config.yml | 31 +++++++++++++++++++++++++++++++
doc/content/index.md | 1 +
doc/moosedocs.py | 29 +++++++++++++++++++++++++++++
doc/sqa_reports.yml | 8 ++++++++
4 files changed, 69 insertions(+)
create mode 100644 doc/config.yml
create mode 100644 doc/content/index.md
create mode 100755 doc/moosedocs.py
create mode 100644 doc/sqa_reports.yml
diff --git a/doc/config.yml b/doc/config.yml
new file mode 100644
index 0000000000..66667e2528
--- /dev/null
+++ b/doc/config.yml
@@ -0,0 +1,31 @@
+Content:
+ moltres:
+ root_dir: ${ROOT_DIR}/doc/content
+ moose:
+ root_dir: ${MOOSE_DIR}/framework/doc/content
+ content:
+ - js/*
+ - css/*
+ - contrib/**
+ - media/**
+ - templates/stubs/*
+
+Renderer:
+ type: MooseDocs.base.MaterializeRenderer
+
+Extensions:
+ MooseDocs.extensions.template:
+ active: True
+ MooseDocs.extensions.navigation:
+ name: Moltres
+ repo: https://github.com/arfc/moltres
+ menu:
+ Getting Started: getting_started.md
+ Documentation: source/index.md
+ Help: help.md
+ Citing: citing.md
+ MooseDocs.extensions.appsyntax:
+ executable: ${ROOT_DIR}
+ remove: !include ${MOOSE_DIR}/framework/doc/remove.yml
+ includes:
+ - include
diff --git a/doc/content/index.md b/doc/content/index.md
new file mode 100644
index 0000000000..d39d23f702
--- /dev/null
+++ b/doc/content/index.md
@@ -0,0 +1 @@
+# Moltres
diff --git a/doc/moosedocs.py b/doc/moosedocs.py
new file mode 100755
index 0000000000..3cb7f506ae
--- /dev/null
+++ b/doc/moosedocs.py
@@ -0,0 +1,29 @@
+#!/usr/bin/env python
+#* This file is part of the MOOSE framework
+#* https://www.mooseframework.org
+#*
+#* All rights reserved, see COPYRIGHT for full restrictions
+#* https://github.com/idaholab/moose/blob/master/COPYRIGHT
+#*
+#* Licensed under LGPL 2.1, please see LICENSE for details
+#* https://www.gnu.org/licenses/lgpl-2.1.html
+
+import sys
+import os
+
+# Locate MOOSE directory
+MOOSE_DIR = os.getenv('MOOSE_DIR', os.path.abspath(os.path.join(os.path.dirname(__name__), '..', 'moose')))
+if not os.path.exists(MOOSE_DIR):
+ MOOSE_DIR = os.path.abspath(os.path.join(os.path.dirname(__name__), '..', '..', 'moose'))
+if not os.path.exists(MOOSE_DIR):
+ raise Exception('Failed to locate MOOSE, specify the MOOSE_DIR environment variable.')
+os.environ['MOOSE_DIR'] = MOOSE_DIR
+
+# Append MOOSE python directory
+MOOSE_PYTHON_DIR = os.path.join(MOOSE_DIR, 'python')
+if MOOSE_PYTHON_DIR not in sys.path:
+ sys.path.append(MOOSE_PYTHON_DIR)
+
+from MooseDocs import main
+if __name__ == '__main__':
+ sys.exit(main.run())
diff --git a/doc/sqa_reports.yml b/doc/sqa_reports.yml
new file mode 100644
index 0000000000..b2b94b4097
--- /dev/null
+++ b/doc/sqa_reports.yml
@@ -0,0 +1,8 @@
+Applications:
+ moltres:
+ app_types:
+ - MoltresApp
+ content_directory: ${ROOT_DIR}/doc/content
+ remove:
+ log_default: WARNING
+ show_warning: false
From ff28ce0f89a2f2c84f79a3d1c7172539742380d2 Mon Sep 17 00:00:00 2001
From: Sun Myung Park <park_cg@live.com>
Date: Fri, 29 Oct 2021 16:12:46 -0500
Subject: [PATCH 2/2] Create basic webpages for MooseDocs
---
doc/content/citing.md | 19 +++++++++++++++++++
doc/content/getting_started.md | 3 +++
doc/content/help.md | 3 +++
doc/content/source/index.md | 5 +++++
4 files changed, 30 insertions(+)
create mode 100644 doc/content/citing.md
create mode 100644 doc/content/getting_started.md
create mode 100644 doc/content/help.md
create mode 100644 doc/content/source/index.md
diff --git a/doc/content/citing.md b/doc/content/citing.md
new file mode 100644
index 0000000000..03e44055aa
--- /dev/null
+++ b/doc/content/citing.md
@@ -0,0 +1,19 @@
+# Citing Moltres
+
+You may cite Moltres through the following publication:
+
+```tex
+@article{lindsay_introduction_2018,
+ title = {Introduction to {Moltres}: {An} application for simulation of {Molten} {Salt} {Reactors}},
+ volume = {114},
+ issn = {0306-4549},
+ url = {https://linkinghub.elsevier.com/retrieve/pii/S0306454917304760},
+ doi = {10.1016/j.anucene.2017.12.025},
+ journal = {Annals of Nuclear Energy},
+ author = {Lindsay, Alexander and Ridley, Gavin and Rykhlevskii, Andrei and Huff, Kathryn},
+ month = apr,
+ year = {2018},
+ keywords = {Reactor physics, Nuclear fuel cycle, nuclear engineering, agent based modeling, Hydrologic contaminant transport, Object orientation, repository, Systems analysis, Simulation, Multiphysics, Finite elements, MOOSE, Parallel computing},
+ pages = {530--540},
+}
+```
diff --git a/doc/content/getting_started.md b/doc/content/getting_started.md
new file mode 100644
index 0000000000..be1ec1643d
--- /dev/null
+++ b/doc/content/getting_started.md
@@ -0,0 +1,3 @@
+# Getting Started
+
+TODO: Add getting started instructions
diff --git a/doc/content/help.md b/doc/content/help.md
new file mode 100644
index 0000000000..e5ee619e3f
--- /dev/null
+++ b/doc/content/help.md
@@ -0,0 +1,3 @@
+# Help
+
+TODO: Add help information
diff --git a/doc/content/source/index.md b/doc/content/source/index.md
new file mode 100644
index 0000000000..500649133f
--- /dev/null
+++ b/doc/content/source/index.md
@@ -0,0 +1,5 @@
+# Source Documentation
+
+The following is a complete list of documented C++ source files in Moltres.
+
+!content list location=source