Skip to content

Commit

Permalink
Merge pull request #12 from mrouhi13/fix/doc-improvement
Browse files Browse the repository at this point in the history
Improve documents
  • Loading branch information
mrouhi13 committed Aug 2, 2019
2 parents 2714900 + b910a28 commit 05c45c2
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Djecrety
.. image:: https://codecov.io/gh/mrouhi13/djecrety/branch/master/graph/badge.svg
:target: https://codecov.io/gh/mrouhi13/djecrety

Djecrety is a Django implementation of a `Web tool <https://djecrety.ir/>`_ with the same name. This package provides a command to generate a new secret key for your project and save it to ``settings.py`` file.
Djecrety is a Django implementation of a `Web tool <https://djecrety.ir/>`_ with the same name. This package provides a command to generate a new secret key for your project and save it to ``settings.py``.

For more details `http://djecrety.readthedocs.io <http://djecrety.readthedocs.io>`_

Expand Down
1 change: 1 addition & 0 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Supported Django versions
* Django 2.0
* Django 2.1
* Django 2.2
* Django 2.3

Installation
------------
Expand Down
4 changes: 2 additions & 2 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Introduction
============

**Djecrety** is an implementation of the Django package from a `Web tool <https://djecrety.ir/>`_ with the same name.
This package provides a command to generate a new secret key for your project and save it to ``settings.py`` file.
**Djecrety** is a Django implementation of a `Web tool <https://djecrety.ir/>`_ with the same name.
This package provides a command to generate a new secret key for your project and save it to ``settings.py``.

You can use `Djecrety <https://djecrety.ir/>`_ web tool or simply install this package for automated testing and deployment.

Expand Down
8 changes: 4 additions & 4 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ Let's go!
$ ./manage.py djecrety
* With ``-s`` argument, save the generated secret key to ``settings.py`` file:
* With ``-s`` argument, save the generated secret key to ``settings.py``:

.. code-block:: text
$ ./manage.py djecrety -s
* With ``-p`` argument, display the generated secret key when saving on file:
* With ``-p`` argument, display the generated secret key when saving to the file:

.. note::

``-p`` argument work when saving the secret key to file.
``-p`` argument work when saving the secret key to the file.

.. code-block:: text
Expand All @@ -31,7 +31,7 @@ Let's go!

.. note::

By default, we try to detect your project directory and ``settings.py`` file location, if ``settings.py`` file not in default location you can specify the directory.
By default, we try to detect your project directory and ``settings.py`` location, if ``settings.py`` not in default location you can specify the directory.

.. code-block:: text
Expand Down

0 comments on commit 05c45c2

Please sign in to comment.