Skip to content

Commit a9acf3f

Browse files
committed
fix doc TOC and bulleted list issue for html and pdf
1 parent 530ffcc commit a9acf3f

File tree

4 files changed

+27
-24
lines changed

4 files changed

+27
-24
lines changed

doc/source/_static/style.css

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,3 @@
22
font-size: 24px; /* Or any size you prefer */
33
font-weight: bold; /* If you want it bold */
44
}
5-
.extrabig {
6-
font-size: 36px; /* Or any size you prefer */
7-
font-weight: bold; /* If you want it bold */
8-
}

doc/source/conf.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,6 @@
8080

8181
latex_engine = "xelatex"
8282

83-
# def add_page_class(app, pagename, templatename, context, doctree):
84-
# from sphinx.builders.html._assets import _CascadingStyleSheet
85-
# context['css_files'] += [_CascadingStyleSheet(f'_static/{pagename}.css')]
86-
8783
def setup(app):
8884
# Register a sphinx.ext.autodoc.between listener to ignore everything
8985
# between lines that contain the word IGNORE

doc/source/index.rst

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
11
.. include:: ./refs.rst
22
.. role:: big
3-
.. role:: extrabig
4-
5-
.. we use big role instead of index because a TOC on this page screws up the latex page generation
6-
7-
:extrabig:`Django Typer`
83

4+
============
5+
Django Typer
6+
============
97

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

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

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

2827
:big:`Installation`
2928

doc/source/tutorial.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ Using the :class:`~django_typer.TyperCommand` class is very similar to using the
88
class. The main difference is that we use Typer_'s decorators, classes and type annotations
99
to define the command's command line interface instead of argparse_ as BaseCommand_ expects.
1010

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

0 commit comments

Comments
 (0)