Skip to content

Commit

Permalink
fix pypi readme and add extra dependency sets
Browse files Browse the repository at this point in the history
  • Loading branch information
bckohan committed Dec 19, 2023
1 parent 80974af commit c28ad7a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,14 +115,14 @@ like so:
This would generate html that looks like this:

.. image:: https://github.com/bckohan/sphinxcontrib-typer/blob/main/example.html.png
.. image:: https://raw.githubusercontent.com/bckohan/sphinxcontrib-typer/main/example.html.png
:width: 100%
:align: center


You could change ``:preferred:`` to svg, to generate svg instead:

.. image:: https://github.com/bckohan/sphinxcontrib-typer/blob/main/example.svg
.. image:: https://raw.githubusercontent.com/bckohan/sphinxcontrib-typer/main/example.svg
:width: 100%
:align: center

Expand All @@ -134,15 +134,15 @@ Or to text::
This is the callback function.
╭─ Options ──────────────────────────────────────────────────────────────────────────────
│ --flag1 --no-flag1 Flag 1. [default: no-flag1]
│ --flag2 --no-flag2 Flag 2. [default: no-flag2]
│ --help Show this message and exit.
╰────────────────────────────────────────────────────────────────────────────────────────
╭─ Commands ─────────────────────────────────────────────────────────────────────────────
│ bar This is the bar command.
│ foo This is the foo command.
╰────────────────────────────────────────────────────────────────────────────────────────
╭─ Options ──────────────────────────────────────────────────────────╮
│ --flag1 --no-flag1 Flag 1. [default: no-flag1] │
│ --flag2 --no-flag2 Flag 2. [default: no-flag2] │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────╮
│ bar This is the bar command. │
│ foo This is the foo command. │
╰────────────────────────────────────────────────────────────────────╯


The ``typer`` directive has options for generating docs for all subcommands as well
Expand Down
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,8 @@ line_length = 79

[tool.doc8]
max-line-length = 100

[tool.poetry.extras]
html = ["selenium", "webdriver-manager"]
pdf = ["cairosvg", "lxml", "tinycss2", "cssselect2"]
html = ["selenium", "webdriver-manager", "pillow"]

0 comments on commit c28ad7a

Please sign in to comment.