Skip to content

Commit b1188c5

Browse files
unixwzrdunixwzrd
committed
pathcheck
1 parent aa6c264 commit b1188c5

File tree

8 files changed

+78
-78
lines changed

8 files changed

+78
-78
lines changed

‎bin/shinclude/help_sys.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ generate_markdown() {
505505
for script_path in "${script_files[@]}"; do
506506
local script_name
507507
script_name=$(basename "$script_path")
508-
local script_index_file="${doc_dir}/${script_name//./_}.md"
508+
local script_index_file="${dir_name}/${script_name//./_}.md"
509509

510510
log_message "INFO" "Generating markdown for script: $script_name"
511511

‎docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
# List of scripts in project
55

66
<pre><table>
7-
<tr><td><a href="docs/shdoc/bin/shinclude/errno_sh.md">errno.sh</a></td><td>Provides POSIX errno codes and utilities for Bash scripts</td></tr>
8-
<tr><td><a href="docs/shdoc/bin/shinclude/help_sys_sh.md">help_sys.sh</a></td><td>Help System Functions for Bash Scripts</td></tr>
9-
<tr><td><a href="docs/shdoc/bin/shinclude/init_env_sh.md">init_env.sh</a></td><td>Initialize Environment and Source Utility Scripts</td></tr>
10-
<tr><td><a href="docs/shdoc/bin/shinclude/util_funcs_sh.md">util_funcs.sh</a></td><td>Utility Functions for Bash Scripts</td></tr>
11-
<tr><td><a href="docs/shdoc/bin/shinclude/venv_funcs_sh.md">venv_funcs.sh</a></td><td>Virtual Environment Management Functions for Bash Scripts</td></tr>
12-
<tr><td><a href="docs/shdoc/bin/shinclude/wrapper_funcs_sh.md">wrapper_funcs.sh</a></td><td>Python Package Manager Wrapper Functions</td></tr>
7+
<tr><td><a href="shdoc/bin/shinclude/errno_sh.md">errno.sh</a></td><td>Provides POSIX errno codes and utilities for Bash scripts</td></tr>
8+
<tr><td><a href="shdoc/bin/shinclude/help_sys_sh.md">help_sys.sh</a></td><td>Help System Functions for Bash Scripts</td></tr>
9+
<tr><td><a href="shdoc/bin/shinclude/init_env_sh.md">init_env.sh</a></td><td>Initialize Environment and Source Utility Scripts</td></tr>
10+
<tr><td><a href="shdoc/bin/shinclude/util_funcs_sh.md">util_funcs.sh</a></td><td>Utility Functions for Bash Scripts</td></tr>
11+
<tr><td><a href="shdoc/bin/shinclude/venv_funcs_sh.md">venv_funcs.sh</a></td><td>Virtual Environment Management Functions for Bash Scripts</td></tr>
12+
<tr><td><a href="shdoc/bin/shinclude/wrapper_funcs_sh.md">wrapper_funcs.sh</a></td><td>Python Package Manager Wrapper Functions</td></tr>
1313
</table></pre>
1414

1515
---

‎docs/shdoc/bin/shinclude/errno_sh.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# List of functions in script: errno.sh
22

3-
### [errno.sh](/docs/shdoc/bin/shinclude/scripts/errno.sh.md) - Provides POSIX errno codes and utilities for Bash scripts
3+
### [errno.sh](/scripts/errno.sh.md) - Provides POSIX errno codes and utilities for Bash scripts
44

5-
## List of functions in script: [errno.sh](docs/shdoc/bin/shinclude/scripts/errno.sh.md)
5+
## List of functions in script: [errno.sh](scripts/errno.sh.md)
66

77
<pre><table>
8-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/errno.md">errno</a></td><td>Provides POSIX errno codes and values for use in scripts or lookup of error codes on the command line.</td></tr>
9-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/errfind.md">errfind</a></td><td>Find the error code for a given string.</td></tr>
10-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/errno_warn.md">errno_warn</a></td><td>Prints a warning using the errno function to STDERR and returns the error number.</td></tr>
11-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/errno_exit.md">errno_exit</a></td><td>Prints an error to STDERR using the errno function and exits with the error number.</td></tr>
12-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/log_message.md">log_message</a></td><td>## Description</td></tr>
8+
<tr><td><a href="functions/errno.md">errno</a></td><td>Provides POSIX errno codes and values for use in scripts or lookup of error codes on the command line.</td></tr>
9+
<tr><td><a href="functions/errfind.md">errfind</a></td><td>Find the error code for a given string.</td></tr>
10+
<tr><td><a href="functions/errno_warn.md">errno_warn</a></td><td>Prints a warning using the errno function to STDERR and returns the error number.</td></tr>
11+
<tr><td><a href="functions/errno_exit.md">errno_exit</a></td><td>Prints an error to STDERR using the errno function and exits with the error number.</td></tr>
12+
<tr><td><a href="functions/log_message.md">log_message</a></td><td>## Description</td></tr>
1313
</table></pre>
1414

1515
---

‎docs/shdoc/bin/shinclude/help_sys_sh.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
# List of functions in script: help_sys.sh
22

3-
### [help_sys.sh](/docs/shdoc/bin/shinclude/scripts/help_sys.sh.md) - Help System Functions for Bash Scripts
3+
### [help_sys.sh](/scripts/help_sys.sh.md) - Help System Functions for Bash Scripts
44

5-
## List of functions in script: [help_sys.sh](docs/shdoc/bin/shinclude/scripts/help_sys.sh.md)
5+
## List of functions in script: [help_sys.sh](scripts/help_sys.sh.md)
66

77
<pre><table>
8-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/process_scripts.md">process_scripts</a></td><td>Process scripts in a given directory.</td></tr>
9-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/init_help_system.md">init_help_system</a></td><td>Initialize the help system by populating function and script documentation.</td></tr>
10-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/script_description.md">script_description</a></td><td>Get the description of a script.</td></tr>
11-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/function_description.md">function_description</a></td><td>Get the description of a function.</td></tr>
12-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/write_index_header.md">write_index_header</a></td><td>Writes the header section of the README.</td></tr>
13-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/generate_nbsp_padding.md">generate_nbsp_padding</a></td><td>* [help_sys.sh](/docs/shdoc/bin/shinclude/help_sys_sh.md)</td></tr>
14-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/write_readme_entry.md">write_readme_entry</a></td><td>Creates an entry in the README for a script or function.</td></tr>
15-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/write_script_index_header.md">write_script_index_header</a></td><td>Write the description of the script and the functions contained in it</td></tr>
16-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/write_script_function_entry.md">write_script_function_entry</a></td><td>Write a function entry in the documentation.</td></tr>
17-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/write_script_doc.md">write_script_doc</a></td><td>Write the documentation for a script.</td></tr>
18-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/write_function_doc.md">write_function_doc</a></td><td>Write the documentation for a function.</td></tr>
19-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/write_table_footer.md">write_table_footer</a></td><td>Write the footer section of the README.</td></tr>
20-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/write_page_footer.md">write_page_footer</a></td><td>Writes a standard footer for any document file</td></tr>
21-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/generate_markdown.md">generate_markdown</a></td><td>Generate Markdown documentation for all available functions.</td></tr>
22-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/general_help.md">general_help</a></td><td>Display general help options for the 'help' command.</td></tr>
23-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/help_scripts.md">help_scripts</a></td><td>List sourced scripts and their purpose.</td></tr>
24-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/specific_script_help.md">specific_script_help</a></td><td>Provide detailed documentation for a given script.</td></tr>
25-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/specific_function_help.md">specific_function_help</a></td><td>Provide detailed documentation for a given function.</td></tr>
26-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/help_functions.md">help_functions</a></td><td>List available functions and how to get their documentation.</td></tr>
27-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/vhelp.md">vhelp</a></td><td>Main entry point for the help system.</td></tr>
8+
<tr><td><a href="functions/process_scripts.md">process_scripts</a></td><td>Process scripts in a given directory.</td></tr>
9+
<tr><td><a href="functions/init_help_system.md">init_help_system</a></td><td>Initialize the help system by populating function and script documentation.</td></tr>
10+
<tr><td><a href="functions/script_description.md">script_description</a></td><td>Get the description of a script.</td></tr>
11+
<tr><td><a href="functions/function_description.md">function_description</a></td><td>Get the description of a function.</td></tr>
12+
<tr><td><a href="functions/write_index_header.md">write_index_header</a></td><td>Writes the header section of the README.</td></tr>
13+
<tr><td><a href="functions/generate_nbsp_padding.md">generate_nbsp_padding</a></td><td>* [help_sys.sh](/help_sys_sh.md)</td></tr>
14+
<tr><td><a href="functions/write_readme_entry.md">write_readme_entry</a></td><td>Creates an entry in the README for a script or function.</td></tr>
15+
<tr><td><a href="functions/write_script_index_header.md">write_script_index_header</a></td><td>Write the description of the script and the functions contained in it</td></tr>
16+
<tr><td><a href="functions/write_script_function_entry.md">write_script_function_entry</a></td><td>Write a function entry in the documentation.</td></tr>
17+
<tr><td><a href="functions/write_script_doc.md">write_script_doc</a></td><td>Write the documentation for a script.</td></tr>
18+
<tr><td><a href="functions/write_function_doc.md">write_function_doc</a></td><td>Write the documentation for a function.</td></tr>
19+
<tr><td><a href="functions/write_table_footer.md">write_table_footer</a></td><td>Write the footer section of the README.</td></tr>
20+
<tr><td><a href="functions/write_page_footer.md">write_page_footer</a></td><td>Writes a standard footer for any document file</td></tr>
21+
<tr><td><a href="functions/generate_markdown.md">generate_markdown</a></td><td>Generate Markdown documentation for all available functions.</td></tr>
22+
<tr><td><a href="functions/general_help.md">general_help</a></td><td>Display general help options for the 'help' command.</td></tr>
23+
<tr><td><a href="functions/help_scripts.md">help_scripts</a></td><td>List sourced scripts and their purpose.</td></tr>
24+
<tr><td><a href="functions/specific_script_help.md">specific_script_help</a></td><td>Provide detailed documentation for a given script.</td></tr>
25+
<tr><td><a href="functions/specific_function_help.md">specific_function_help</a></td><td>Provide detailed documentation for a given function.</td></tr>
26+
<tr><td><a href="functions/help_functions.md">help_functions</a></td><td>List available functions and how to get their documentation.</td></tr>
27+
<tr><td><a href="functions/vhelp.md">vhelp</a></td><td>Main entry point for the help system.</td></tr>
2828
</table></pre>
2929

3030
---

‎docs/shdoc/bin/shinclude/init_env_sh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# List of functions in script: init_env.sh
22

3-
### [init_env.sh](/docs/shdoc/bin/shinclude/scripts/init_env.sh.md) - Initialize Environment and Source Utility Scripts
3+
### [init_env.sh](/scripts/init_env.sh.md) - Initialize Environment and Source Utility Scripts
44

5-
## List of functions in script: [init_env.sh](docs/shdoc/bin/shinclude/scripts/init_env.sh.md)
5+
## List of functions in script: [init_env.sh](scripts/init_env.sh.md)
66

77
<pre><table>
8-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/source_util_script.md">source_util_script</a></td><td>Sources a utility script from the specified directory.</td></tr>
8+
<tr><td><a href="functions/source_util_script.md">source_util_script</a></td><td>Sources a utility script from the specified directory.</td></tr>
99
</table></pre>
1010

1111
---

‎docs/shdoc/bin/shinclude/util_funcs_sh.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# List of functions in script: util_funcs.sh
22

3-
### [util_funcs.sh](/docs/shdoc/bin/shinclude/scripts/util_funcs.sh.md) - Utility Functions for Bash Scripts
3+
### [util_funcs.sh](/scripts/util_funcs.sh.md) - Utility Functions for Bash Scripts
44

5-
## List of functions in script: [util_funcs.sh](docs/shdoc/bin/shinclude/scripts/util_funcs.sh.md)
5+
## List of functions in script: [util_funcs.sh](scripts/util_funcs.sh.md)
66

77
<pre><table>
8-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/strip_space.md">strip_space</a></td><td>Remove Leading and Trailing Whitespaces</td></tr>
9-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/zero_pad.md">zero_pad</a></td><td>Pad a Single-Digit Number with a Leading Zero</td></tr>
10-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/next_step.md">next_step</a></td><td>Increment a Given Sequence Number by 1 and Pad it with a Zero if Needed</td></tr>
11-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/sort_2d_array.md">sort_2d_array</a></td><td>Sort a Two-Dimensional Array</td></tr>
12-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/push_stack.md">push_stack</a></td><td>Push a Value onto a Named Stack</td></tr>
13-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/pop_stack.md">pop_stack</a></td><td>Pop a Value from a Named Stack</td></tr>
14-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/stack_op.md">stack_op</a></td><td>Perform Stack Operations</td></tr>
15-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/stringclean.md">stringclean</a></td><td>Sanitize a String by Removing Non-Alphanumeric Characters</td></tr>
16-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/to_upper.md">to_upper</a></td><td>Convert a String to Uppercase</td></tr>
17-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/ptree.md">ptree</a></td><td>Display the Process Tree for a Given PID</td></tr>
18-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/var_type.md">var_type</a></td><td>Get the Type of a Variable</td></tr>
8+
<tr><td><a href="functions/strip_space.md">strip_space</a></td><td>Remove Leading and Trailing Whitespaces</td></tr>
9+
<tr><td><a href="functions/zero_pad.md">zero_pad</a></td><td>Pad a Single-Digit Number with a Leading Zero</td></tr>
10+
<tr><td><a href="functions/next_step.md">next_step</a></td><td>Increment a Given Sequence Number by 1 and Pad it with a Zero if Needed</td></tr>
11+
<tr><td><a href="functions/sort_2d_array.md">sort_2d_array</a></td><td>Sort a Two-Dimensional Array</td></tr>
12+
<tr><td><a href="functions/push_stack.md">push_stack</a></td><td>Push a Value onto a Named Stack</td></tr>
13+
<tr><td><a href="functions/pop_stack.md">pop_stack</a></td><td>Pop a Value from a Named Stack</td></tr>
14+
<tr><td><a href="functions/stack_op.md">stack_op</a></td><td>Perform Stack Operations</td></tr>
15+
<tr><td><a href="functions/stringclean.md">stringclean</a></td><td>Sanitize a String by Removing Non-Alphanumeric Characters</td></tr>
16+
<tr><td><a href="functions/to_upper.md">to_upper</a></td><td>Convert a String to Uppercase</td></tr>
17+
<tr><td><a href="functions/ptree.md">ptree</a></td><td>Display the Process Tree for a Given PID</td></tr>
18+
<tr><td><a href="functions/var_type.md">var_type</a></td><td>Get the Type of a Variable</td></tr>
1919
</table></pre>
2020

2121
---

‎docs/shdoc/bin/shinclude/venv_funcs_sh.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# List of functions in script: venv_funcs.sh
22

3-
### [venv_funcs.sh](/docs/shdoc/bin/shinclude/scripts/venv_funcs.sh.md) - Virtual Environment Management Functions for Bash Scripts
3+
### [venv_funcs.sh](/scripts/venv_funcs.sh.md) - Virtual Environment Management Functions for Bash Scripts
44

5-
## List of functions in script: [venv_funcs.sh](docs/shdoc/bin/shinclude/scripts/venv_funcs.sh.md)
5+
## List of functions in script: [venv_funcs.sh](scripts/venv_funcs.sh.md)
66

77
<pre><table>
8-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/push_venv.md">push_venv</a></td><td>Specialized push the default VENV onto the stack.</td></tr>
9-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/pop_venv.md">pop_venv</a></td><td>Specialized pop the VENV off the stack and decrement.</td></tr>
10-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/__set_venv_vars.md">__set_venv_vars</a></td><td>Sets internal VENV variables.</td></tr>
11-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/snum.md">snum</a></td><td>Force set the VENV Sequence number.</td></tr>
12-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/vpfx.md">vpfx</a></td><td>Return the current VENV prefix.</td></tr>
13-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/vnum.md">vnum</a></td><td>Return the current VENV sequence number.</td></tr>
14-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/vdsc.md">vdsc</a></td><td>Return the current VENV description.</td></tr>
15-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/cact.md">cact</a></td><td>Change active VENV.</td></tr>
16-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/dact.md">dact</a></td><td>Deactivate the current VENV.</td></tr>
17-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/pact.md">pact</a></td><td>Switch to the Previous Active VENV.</td></tr>
18-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/lenv.md">lenv</a></td><td>List All Current VENVs with last modification date.</td></tr>
19-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/lastenv.md">lastenv</a></td><td>Retrieve the Last Environment with a Given Prefix.</td></tr>
20-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/benv.md">benv</a></td><td>Create a New Base Virtual Environment.</td></tr>
21-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/nenv.md">nenv</a></td><td>Create a New Virtual Environment in a Series.</td></tr>
22-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/denv.md">denv</a></td><td>Delete a Virtual Environment.</td></tr>
23-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/renv.md">renv</a></td><td>Revert to Previous Virtual Environment.</td></tr>
24-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/ccln.md">ccln</a></td><td>Clone a Conda Environment.</td></tr>
25-
<tr><td><a href="docs/shdoc/bin/shinclude/functions/venvdiff.md">venvdiff</a></td><td>Compare Two Virtual Environments.</td></tr>
8+
<tr><td><a href="functions/push_venv.md">push_venv</a></td><td>Specialized push the default VENV onto the stack.</td></tr>
9+
<tr><td><a href="functions/pop_venv.md">pop_venv</a></td><td>Specialized pop the VENV off the stack and decrement.</td></tr>
10+
<tr><td><a href="functions/__set_venv_vars.md">__set_venv_vars</a></td><td>Sets internal VENV variables.</td></tr>
11+
<tr><td><a href="functions/snum.md">snum</a></td><td>Force set the VENV Sequence number.</td></tr>
12+
<tr><td><a href="functions/vpfx.md">vpfx</a></td><td>Return the current VENV prefix.</td></tr>
13+
<tr><td><a href="functions/vnum.md">vnum</a></td><td>Return the current VENV sequence number.</td></tr>
14+
<tr><td><a href="functions/vdsc.md">vdsc</a></td><td>Return the current VENV description.</td></tr>
15+
<tr><td><a href="functions/cact.md">cact</a></td><td>Change active VENV.</td></tr>
16+
<tr><td><a href="functions/dact.md">dact</a></td><td>Deactivate the current VENV.</td></tr>
17+
<tr><td><a href="functions/pact.md">pact</a></td><td>Switch to the Previous Active VENV.</td></tr>
18+
<tr><td><a href="functions/lenv.md">lenv</a></td><td>List All Current VENVs with last modification date.</td></tr>
19+
<tr><td><a href="functions/lastenv.md">lastenv</a></td><td>Retrieve the Last Environment with a Given Prefix.</td></tr>
20+
<tr><td><a href="functions/benv.md">benv</a></td><td>Create a New Base Virtual Environment.</td></tr>
21+
<tr><td><a href="functions/nenv.md">nenv</a></td><td>Create a New Virtual Environment in a Series.</td></tr>
22+
<tr><td><a href="functions/denv.md">denv</a></td><td>Delete a Virtual Environment.</td></tr>
23+
<tr><td><a href="functions/renv.md">renv</a></td><td>Revert to Previous Virtual Environment.</td></tr>
24+
<tr><td><a href="functions/ccln.md">ccln</a></td><td>Clone a Conda Environment.</td></tr>
25+
<tr><td><a href="functions/venvdiff.md">venvdiff</a></td><td>Compare Two Virtual Environments.</td></tr>
2626
</table></pre>
2727

2828
---

0 commit comments

Comments
 (0)