Comments (7)
I see. Well, discarding the title page could be done in Typer CLI, I would probably take a PR with a --include-title
flag that defaults to True
and can be disabled if that helps.
Having it integrated with Sphinx like sphinx-click
would probably require an external plugin. Or an extension to sphinx-click
. I'm not sure how that would work, but it would probably work better as an external project.
from typer.
Did anyone do any work on this? I'm in the process of starting a new cli-project, and it would be very nice to have some automated docs, like sphinx-click
..
from typer.
So, this would actually be a feature request for Typer CLI not for Typer itself.
I'm personally not a fan of Sphinx and reStructuredText 😅
But maybe if supporting it is not very complex and can be done in a similar way as Markdown I would probably accept PRs there.
from typer.
It does not need to be reStructuredText, markdown works just fine with Sphinx 👍
from typer.
Ah, cool! Although in that case, I'm not sure I understand what would be the feature request 🤔
from typer.
I was thinking of the following:
- It would be nice if I could avoid the workaround, where I have to discard the page title.
- It would be nice if simply by running the sphinx command, the documentation would be built. No need for the Makefile workaround. The behavior would be similar to
sphinx-click
.
from typer.
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.
Related Issues (20)
- New setting to increase the width of the rich (exception) output HOT 1
- [QUESTION] Disable traceback globally on production HOT 4
- printing f-string returns nothing in terminal (win10) HOT 1
- How do I pass the None value explicitly? HOT 2
- Documentation is misleading. new `typer.run` behavior HOT 2
- See if rich 13.x is compatible HOT 4
- Using `some_type | None` syntax for type annotations causes error in python 3.11 HOT 12
- unlimited argument for an option with comma spliter HOT 1
- TAB completion is giving local directory files where command is called. HOT 2
- Support for bytes in Options and Arguments HOT 2
- Is it possible to include a Prolog in `--help` HOT 2
- Get the typer output with html format to provide it to termynal HOT 4
- how to use typer on class method __init__ with self argument, got this error: Error: Missing argument 'SELF'. HOT 2
- Support for localization of messages HOT 1
- Auto-completion when application works in 2 modes (GUI, CLI) HOT 1
- DOC: Documentation of passing multiple values in "option" vs "argument" isn't sufficiently explicit HOT 1
- SIGINT from docker is ignored HOT 4
- 🚀 Roadmap HOT 2
- Source distribution of 0.11.0 is missing the `docs_src` folder HOT 1
- 🐛 Upgrading from `typer<0.12.0` to `typer==0.12.0` breaks the install by partially removing the package/module files HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typer.