Skip to content

Commit

Permalink
fix doc TOC and bulleted list issue for html and pdf
Browse files Browse the repository at this point in the history
  • Loading branch information
bckohan committed Feb 26, 2024
1 parent 530ffcc commit a9acf3f
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 24 deletions.
4 changes: 0 additions & 4 deletions doc/source/_static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,3 @@
font-size: 24px; /* Or any size you prefer */
font-weight: bold; /* If you want it bold */
}
.extrabig {
font-size: 36px; /* Or any size you prefer */
font-weight: bold; /* If you want it bold */
}
4 changes: 0 additions & 4 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,6 @@

latex_engine = "xelatex"

# def add_page_class(app, pagename, templatename, context, doctree):
# from sphinx.builders.html._assets import _CascadingStyleSheet
# context['css_files'] += [_CascadingStyleSheet(f'_static/{pagename}.css')]

def setup(app):
# Register a sphinx.ext.autodoc.between listener to ignore everything
# between lines that contain the word IGNORE
Expand Down
31 changes: 15 additions & 16 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
.. include:: ./refs.rst
.. role:: big
.. role:: extrabig

.. we use big role instead of index because a TOC on this page screws up the latex page generation
:extrabig:`Django Typer`

============
Django Typer
============

Use Typer_ to define the CLI for your Django_ management commands. Provides a TyperCommand class
that inherits from BaseCommand_ and allows typer-style annotated parameter types. All of the
BaseCommand functionality is preserved, so that TyperCommand can be a drop in replacement.

**django-typer makes it easy to:**

* Define your command CLI interface in a clear, DRY and safe way using type hints
* Create subcommand and group command hierarchies.
* Use the full power of Typer's parameter types to validate and parse command line inputs.
* Create beautiful and information dense help outputs.
* Configure the rendering of exception stack traces using rich.
* :ref:`Install shell tab-completion support <shellcompletions>` for TyperCommands and normal
Django_ commands for bash_, zsh_, fish_ and powershell_.
* :ref:`Create custom and portable shell tab-completions for your CLI parameters.
<define-shellcompletions>`
* Refactor existing management commands into TyperCommands because TyperCommand is interface
compatible with BaseCommand.
* Define your command CLI interface in a clear, DRY and safe way using type hints
* Create subcommand and group command hierarchies.
* Use the full power of Typer's parameter types to validate and parse command line inputs.
* Create beautiful and information dense help outputs.
* Configure the rendering of exception stack traces using rich.
* :ref:`Install shell tab-completion support <shellcompletions>` for TyperCommands and normal
Django_ commands for bash_, zsh_, fish_ and powershell_.
* :ref:`Create custom and portable shell tab-completions for your CLI parameters.
<define-shellcompletions>`
* Refactor existing management commands into TyperCommands because TyperCommand is interface
compatible with BaseCommand.


:big:`Installation`

Expand Down
12 changes: 12 additions & 0 deletions doc/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ Using the :class:`~django_typer.TyperCommand` class is very similar to using the
class. The main difference is that we use Typer_'s decorators, classes and type annotations
to define the command's command line interface instead of argparse_ as BaseCommand_ expects.

* Define your command CLI interface in a clear, DRY and safe way using type hints
* Create subcommand and group command hierarchies.
* Use the full power of Typer's parameter types to validate and parse command line inputs.
* Create beautiful and information dense help outputs.
* Configure the rendering of exception stack traces using rich.
* :ref:`Install shell tab-completion support <shellcompletions>` for TyperCommands and normal
Django_ commands for bash_, zsh_, fish_ and powershell_.
* :ref:`Create custom and portable shell tab-completions for your CLI parameters.
<define-shellcompletions>`
* Refactor existing management commands into TyperCommands because TyperCommand is interface
compatible with BaseCommand.

Upstream Libraries
------------------

Expand Down

0 comments on commit a9acf3f

Please sign in to comment.