Skip to content

Commit 7c4f574

Browse files
bckohanbckohan
authored
Merge pull request #198 from django-commons/uv
reorganize reference
2 parents 37af898 + 1d31ec2 commit 7c4f574

File tree

11 files changed

+150
-117
lines changed

11 files changed

+150
-117
lines changed

‎doc/source/changelog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ v3.1.0 (2024-03-xx)
1111
* Fixed `fish completion installs should respect XDG_CONFIG_HOME <https://github.com/django-commons/django-typer/issues/193>`_
1212
* Fixed `zsh completion installs should respect ZDOTDIR <https://github.com/django-commons/django-typer/issues/192>`_
1313
* Implemented `Support Django 5.2 <https://github.com/django-commons/django-typer/issues/188>`_
14-
* Implemented `Use intersphinx for external document references. <https://github.com/django-commons/django-typer/issues/187>`
14+
* Implemented `Use intersphinx for external document references. <https://github.com/django-commons/django-typer/issues/187>`_
1515
* Implemented `Switch poetry -> uv <https://github.com/django-commons/django-typer/issues/185>`_
1616
* Implemented `Require tests to pass before release action runs. <https://github.com/django-commons/django-typer/issues/173>`_
1717

‎doc/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,5 +196,5 @@ the self argument in your commands.**
196196
shell_completion
197197
howto
198198
showcase
199-
reference
199+
reference/index
200200
changelog

‎doc/source/reference.rst

Lines changed: 0 additions & 115 deletions
This file was deleted.

‎doc/source/reference/completers.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. include:: ../refs.rst
2+
3+
.. _completers:
4+
5+
==========
6+
Completers
7+
==========
8+
9+
.. automodule:: django_typer.completers
10+
:members:
11+
12+
.. automodule:: django_typer.completers.apps
13+
:members:
14+
15+
.. automodule:: django_typer.completers.cmd
16+
:members:
17+
18+
.. automodule:: django_typer.completers.db
19+
:members:
20+
21+
.. automodule:: django_typer.completers.model
22+
:members:
23+
24+
.. automodule:: django_typer.completers.path
25+
:members:

‎doc/source/reference/index.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. include:: ../refs.rst
2+
3+
.. _reference:
4+
5+
=========
6+
Reference
7+
=========
8+
9+
.. automodule:: django_typer
10+
11+
|
12+
13+
.. toctree::
14+
:maxdepth: 2
15+
:caption: Contents:
16+
17+
management
18+
types
19+
completers
20+
parsers
21+
shell_completion
22+
shells
23+
utils

‎doc/source/reference/management.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. include:: ../refs.rst
2+
3+
.. _management:
4+
5+
==========
6+
Management
7+
==========
8+
9+
.. autoclass:: django_typer.management.TyperCommand
10+
:members:
11+
:special-members: __call__
12+
13+
.. automodule:: django_typer.management
14+
:members:
15+
:exclude-members: Typer, CommandGroup, TyperCommand, Context, CommandNode
16+
:show-inheritance:
17+
18+
.. autoclass:: django_typer.management.Context
19+
:members:
20+
21+
.. autoclass:: django_typer.management.Typer
22+
:members:
23+
24+
.. autoclass:: django_typer.management.TyperParser
25+
:members:
26+
27+
.. autoclass:: django_typer.management.CommandNode
28+
:members:
29+
30+
.. autoclass:: django_typer.management.TyperCommandMeta
31+

‎doc/source/reference/parsers.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. include:: ../refs.rst
2+
3+
.. _parsers:
4+
5+
=======
6+
Parsers
7+
=======
8+
9+
.. automodule:: django_typer.parsers
10+
:members:
11+
12+
.. automodule:: django_typer.parsers.apps
13+
:members:
14+
15+
.. automodule:: django_typer.parsers.model
16+
:members:

‎doc/source/reference/shell_completion.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. include:: ../refs.rst
2+
3+
.. _shellcompletion:
4+
5+
================
6+
Shell Completion
7+
================
8+
9+
.. automodule:: django_typer.management.commands.shellcompletion
10+
:members:

‎doc/source/reference/shells.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. include:: ../refs.rst
2+
3+
.. _shells:
4+
5+
======
6+
Shells
7+
======
8+
9+
.. autoclass:: django_typer.shells.bash.BashComplete
10+
:members: name, template, color, supports_scripts
11+
12+
.. autoclass:: django_typer.shells.zsh.ZshComplete
13+
:members: name, template, color, supports_scripts
14+
15+
.. autoclass:: django_typer.shells.powershell.PowerShellComplete
16+
:members: name, template, color, supports_scripts
17+
18+
.. autoclass:: django_typer.shells.powershell.PwshComplete
19+
:members: name, template, color, supports_scripts
20+
21+
.. autoclass:: django_typer.shells.fish.FishComplete
22+
:members: name, template, color, supports_scripts

‎doc/source/reference/types.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. include:: ../refs.rst
2+
3+
.. _types:
4+
5+
============
6+
Option Types
7+
============
8+
9+
.. automodule:: django_typer.types
10+
:members:
11+

0 commit comments

Comments
 (0)