Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up MooseDocs files for documentation #181

Merged
merged 2 commits into from
Nov 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions doc/config.yml
Original file line number Diff line number Diff line change
@@ -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
19 changes: 19 additions & 0 deletions doc/content/citing.md
Original file line number Diff line number Diff line change
@@ -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},
}
```
3 changes: 3 additions & 0 deletions doc/content/getting_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Getting Started

TODO: Add getting started instructions
3 changes: 3 additions & 0 deletions doc/content/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Help

TODO: Add help information
1 change: 1 addition & 0 deletions doc/content/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Moltres
5 changes: 5 additions & 0 deletions doc/content/source/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Source Documentation

The following is a complete list of documented C++ source files in Moltres.

!content list location=source
29 changes: 29 additions & 0 deletions doc/moosedocs.py
Original file line number Diff line number Diff line change
@@ -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())
8 changes: 8 additions & 0 deletions doc/sqa_reports.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Applications:
moltres:
app_types:
- MoltresApp
content_directory: ${ROOT_DIR}/doc/content
remove:
log_default: WARNING
show_warning: false