-
-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
bugSomething isn't workingSomething isn't working
Description
Is your change request related to a problem? Please describe.
When generating the mkdocs documentation for a bash script, the output html file does not have the valid exit codes as expected.
E.g.
Shell source code snippet:
## @function usage
## @function-brief Displays usage instructions
## @function-stdout Prints usage information
## @exit 0 If usage is displayed
function usage() {
echo "Usage: $0 {startup|shutdown}"
exit 0
}
html output:
...
<ul>
<li>
<em><code></code></em>:
<div class="doc doc-md-description">
<p>If usage is displayed</p>
</div>
</li>
</ul>
...
Describe the solution you'd like
I would exepected that the html code defines the correct exit code as follows
<ul>
<li>
<em><code>0</code></em>:
<div class="doc doc-md-description">
<p>If usage is displayed</p>
</div>
</li>
</ul>
Following setup I have used:
mkdocs 1.6.1
mkdocs-autorefs 1.4.1
mkdocs-get-deps 0.2.0
mkdocs-material 9.6.9
mkdocs-material-extensions 1.3.1
mkdocstrings 0.29.0
mkdocstrings-shell 1.0.1
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't working

