[BUG] Hidden commands should not be included in `typer app.py utils docs` markdown output

[nfrasser]

• I've checked docs and closed issues for possible solutions.
• I can't find my issue in the FAQ.

Describe the bug

When generating a markdown documentation page for a Typer app, commands marked with hidden=True should not be included.

Steps to reproduce:

1. Create a typer app script where one command is marked as hidden, e.g., the delete command in this example:

   import typer
   
   app = typer.Typer(help="Awesome CLI user manager.")
   
   
   @app.command()
   def create(username: str):
       """
       Create a new user with USERNAME.
       """
       pass
       
   
   @app.command(hidden=True)
   def delete(username: str):
       """
       Delete a user with USERNAME.
       
       If --force is not used, will ask for confirmation.
       """
       pass
       
   
   if __name__ == "__main__":
       app()

   Save as app.py
2. Generate the markdown docs with command typer app.py utils docs

Expected: Only the create command details are included in the markdown output
Actual: Both the create and delete command details are included in the markdown output

The commands are correctly excluded when running the app normally with python app.py --help.

Platform

Click to expand

• Linux
• Tmux via iTerm

[github-actions]

Thank you for your issue. Give us a little time to review it.

PS. You might want to check the FAQ if you haven't done so already.

Rich was created by Will McGugan. Consider sponsoring Will's work on Rich.

This is an automated reply, generated by FAQtory

[nfrasser]

Oops sorry wrong repo

[github-actions]

I hope I helped!

Consider sponsoring my work on Rich. I give tech support for free, in addition to maintaining Rich and Textual.

If you like using Rich, you might also enjoy Textual.

Will McGugan

[willmcgugan]

Wrong repo. Try the Typer repository.