Change shdoc style to mkdocstrings format

Open
#2 0 comments 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 1 day

@JonathanTSilva is already working on this.

Since Aug 8, 2025.

Assessment

This issue has not been assessed yet.

Description

documentation

It would be interesting if shdoc generated bash documentation to be interpreted by the project documentation with mkdocstring. To do this, you might need to change the bash file comment documentation to something similar to the Google Python Style docstring.

Dominant language
Shell
Stars
0
Forks
0
Avg merge
8h 41m
Merged PRs (30d)
9

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from JonathanTSilva/scriptize

All issues in JonathanTSilva/scriptize

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.