Skip to content

Commit

Permalink
Remove use of HTML comments in modules/doc/content
Browse files Browse the repository at this point in the history
  • Loading branch information
cticenhour committed Dec 19, 2024
1 parent 31653bb commit b7ad508
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This tutorial is the focus of the live hosted [examples_and_tutorials/index.md#w

!media tutorial01_app_development/moose_intro.png
style=width:80%;display:block;margin-left:auto;margin-right:auto;
<!--Delete this image from `large_media/` or just use it here? I think it looks kind of nice here-->

## Tutorial Contents id=contents

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In [kernel-inheritance], notice that the `ADDiffusion` object is declared as one
caption=Syntax defining the `ADDiffusion` class as an object which inherits from the `ADKernelGrad` class.

!alert note title=Automatic Differentiation
"AD" (often used as a prefix for class names) stands for "Automatic Differentiation," which is a feature available to MOOSE application developers that drastically simplifies the implementation of new a `MooseObject`. <!--The non-AD counterparts of objects are the subject of the next tutorial-->
"AD" (often used as a prefix for class names) stands for "Automatic Differentiation," which is a feature available to MOOSE application developers that drastically simplifies the implementation of new a `MooseObject`.

Now, one might inspect the files that provide the base class, i.e., [`ADKernel.h`](framework/include/kernels/ADKernel.h) and [`ADKernel.C`](framework/src/kernels/ADKernel.C), to see what tools are available and decide how to properly implement a new object of this type. Variable members that `ADKernel` objects have access to include, but are not limited to, the following:

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Caveats:

- Peacock does not work correctly (artifacts during rendering: surface normals are flipped).

<!-- double space on purpose to emphasize important bullet point -->
!! double space on purpose to emphasize important bullet point below

- Different flavors of Linux are available, but +we STRONGLY urge the use of Ubuntu version
20.04.x LTS.+ Use other Linux flavors and versions at your peril if you are interested in using
Expand Down
2 changes: 1 addition & 1 deletion modules/doc/content/help/inl/apptainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ There is an all-encompasing `$CUSTOM_PROMPT` variable that allows you to pass yo
[my-container][12:17:43]>
```

<!-- NOTE to editor: sub children elements require less top positioning (-7 vs -15) -->
!! NOTE to editor: sub children elements require less top positioning (-7 vs -15)

!style! style=position:relative;top:-7px;left:5px;font-style:italic;font-size:small;
(it is not possible to replicate color codes here in documentation, but they are being honored)
Expand Down
9 changes: 5 additions & 4 deletions modules/doc/content/help/inl/hpc_ondemand.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ log in.

The following represents some of the more useful features, and is not an exhaustive list:

!!!
NOTE that the line spacing here is very intentional, in order to give vertical space between the
top-level bullet points.
!!!

- Files, Home Directory

- This will launch a "File Explorer" web browser tab.
Expand All @@ -22,28 +27,24 @@ The following represents some of the more useful features, and is not an exhaust
a native file explorer. File Explorer will also allow you to download and upload files to and
from your machine.

<!-- intentional double space -->

- Jobs, Active Jobs

- Launches a new browser tab listing all scheduled jobs you own.

<!-- intentional double space -->

- Jobs, Job Composer

- Launches a new browser tab allowing you to schedule a new job to be run on one of [!ac](INL)'s
[!ac](HPC) machines.

<!-- intentional double space -->

- Clusters, * Shell Access

- Launches a new browser tab granting an interactive shell prompt to the [!ac](HPC) machine
selected. The interactive shell will be one of the more useful tools when needing direct access
to things like: launching PBS/Slurm jobs manually, building MOOSE, running tests, and more.

<!-- intentional double space -->

- Interactive Apps, Linux Desktop / Linux Deskop with Visualization

Expand Down
12 changes: 6 additions & 6 deletions modules/doc/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@
For more information please click the above image to go to the conference website.
!style-end!

<!-- disable while condference banner is in place
!!! disable while conference banner is in place
!media media/moose_logo.png style=display:block;margin-left:auto;margin-right:auto;width:60%;
-->
!!!

<!-- disable while condference banner is in place
!!! disable while conference banner is in place
!style halign=center fontsize=120% color=0.5 0.5 0.5
Multiphysics Object-Oriented Simulation Environment
-->
!!!

# An open-source, parallel finite element framework class=center style=font-weight:200;font-size:200%

<!-- disable while conference banner is in place
!!! disable while conference banner is in place
!media large_media/gallery/twist_white.webm quicktime=large_media/gallery/twist_white.mp4 style=width:100%; controls=False autoplay=True loop=True
-->
!!!

!row!
!col! small=12 medium=4 large=4 icon=computer
Expand Down
11 changes: 0 additions & 11 deletions modules/doc/content/upcoming_training.md

This file was deleted.

0 comments on commit b7ad508

Please sign in to comment.