Skip to content

Commit

Permalink
Remove use of HTML comments in framework, modules/contact, and python…
Browse files Browse the repository at this point in the history
… docs
  • Loading branch information
cticenhour committed Dec 19, 2024
1 parent b7ad508 commit 8e8bf70
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@ Adds `MeshModifier` objects into the system that are listed under `MeshModifiers
This action adds them to the [application](MooseApp.md).

The preferred syntax for adding `MeshModifiers` is to add them in the `[Mesh]` block.

<!-- !syntax parameters /Mesh/AddMeshModifiersAction -->
2 changes: 1 addition & 1 deletion framework/doc/content/sqa/minimum_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ MacOS releases.
| Memory | 8 GB (16 GBs for debug compilation) |
| Disk Space | 30GB |

<!-- comment to force MooseDocs to separate the tables -->
!! comment to force MooseDocs to separate the tables

| Libraries | Version / Information |
| :- | :- |
Expand Down
3 changes: 0 additions & 3 deletions modules/contact/doc/content/source/userobjects/NodalArea.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

## Description

<!-- The `NodalArea` computes the nodal area along the boundaries. This object is typically utilized in contact simulations while computing the contact pressure along the interface
(see [ContactPressureAux](auxkernels/ContactPressureAux.md)). -->

The `NodalArea` object computes the tributary area of each node on a contact surface, which is used in node/face contact calculations. This object computes the value of a AuxVariable, but is implemented as a UserObject because the calculations involve iterations on the element faces, rather than the nodes. Note that the [Contact](Contact/index.md) action sets this object up automatically, so it is typically not necessary to include this in an input file.


Expand Down
2 changes: 0 additions & 2 deletions python/doc/content/python/MooseDocs/extensions/autolink.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ The `optional` and `exact` settings are similarly applied when handling alternat
!alert warning title=Try not to abuse alternative links.
The `alternative` setting should not be used as a means to circumvent potentially broken content configurations, but rather consciously under special circumstances. For example, its main purpose is to provide a fallback when developing sites designed with [multiple configurations](MooseDocs/config.md#multiconfigs) and cross-links between them, but expeditiously building only one of those configurations such that certain content is only conditionally unavailable.

<!--TODO: The above alert should include a link to the appropriate multiconfigs documentation when it becomes available. See #18137-->

## Automatic Link Shortcuts

Markdown includes syntax for creating shortcuts (see [core.md#shortcut-link]). In MooseDown,
Expand Down

0 comments on commit 8e8bf70

Please sign in to comment.