Skip to content

Commit 3c391a1

Browse files
author
NyanKiyoshi
committed
Add documentation for the diff command
1 parent ba4f3f7 commit 3c391a1

File tree

4 files changed

+26
-1
lines changed

4 files changed

+26
-1
lines changed

docs/_static/diff_results.png

40.7 KB
Loading

docs/diff.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. _diff_usage:
2+
3+
The Diff Command
4+
----------------

docs/index.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,18 @@ Quick Start
5353
| module3 | |
5454
+---------+-------------------------+
5555
56-
4. Or for a nicer presentation, use ``django-queries html > results.txt`` to export the results as HTML. See `this example <./html_export_results.html>`_ for a demo!
56+
4. Or for a nicer presentation, use ``django-queries html > results.html`` to export the results as HTML. See `this example <./html_export_results.html>`_ for a demo!
5757

5858
.. image:: _static/html_export_results.png
5959
:width: 500 px
6060
:align: center
6161

62+
5. By running it twice with the option described :ref:`here <diff_usage>` and by running ``django-queries diff`` you will get something like this:
63+
64+
.. image:: _static/diff_results.png
65+
:width: 500 px
66+
:align: center
67+
6268

6369
Getting Help
6470
============
@@ -76,6 +82,7 @@ More Topics
7682
.. toctree::
7783
:maxdepth: 2
7884

85+
diff
7986
customize
8087
usage
8188
contributing

docs/usage.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,17 @@ The SHOW Command
3939
View a given rapport.
4040
4141
Options: none
42+
43+
44+
The DIFF Command
45+
++++++++++++++++
46+
47+
.. code-block:: text
48+
49+
Usage: django-queries diff [OPTIONS] [LEFT_FILE] [RIGHT_FILE]
50+
51+
Render the diff as a console table with colors.
52+
53+
Options: none
54+
55+
:ref:`More details on how to use the diff command properly. <diff_usage>`

0 commit comments

Comments
 (0)