Code Monkey home page Code Monkey logo

Comments (3)

tiangolo avatar tiangolo commented on May 17, 2024

You can now generate Markdown docs for a Typer app with the new Typer CLI: https://github.com/tiangolo/typer-cli#generate-docs 🎉

It's not documented yet in the main docs, but you can use it already.

from typer.

github-actions avatar github-actions commented on May 17, 2024

Assuming the original issue was solved, it will be automatically closed now. But feel free to add more comments or create new issues.

from typer.

pavel-kalmykov avatar pavel-kalmykov commented on May 17, 2024

Hello @tiangolo.

I tried to use the docs generator tool from the typer-cli and, for some reason, it is not working in my case. Here is my project's structure:

├── README.md
├── my_script
│   ├── __init__.py
│   ├── __main__.py
│   └── main.py
├── poetry.lock
├── pyproject.toml
└── tests
    ├── __init__.py
    └── test_my_script.py

By following your documentation here, this is what I execute and what I am seeing:

typer my_script/main.py utils docs
Usage: typer [OPTIONS] [REPO_PATH]
Try 'typer --help' for help.

Error: Got unexpected extra arguments (utils docs)

It seems like typer directly launches my script (the REPO_PATH argument comes from it) and ignores the rest of the commands (utils and docs). Is this a bug or am I doing something wrong?

PS: I'm using typer-cli 0.0.11 and Python 3.7.9.

from typer.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.