Skip to content

Commit ba5d889

Browse files
committed
more documentation
1 parent edb0607 commit ba5d889

File tree

5 files changed

+32
-7
lines changed

5 files changed

+32
-7
lines changed

docs/changing_default_behavior.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ We provide what we think are sensible behaviors when attempting to access a prot
5151
Loader functions are:
5252
************************************
5353

54-
.. automodule:: jwt_manager.py
54+
.. autoclass:: flask_jwt_extended.jwt_manager.JWTManager
5555
:members:
56-
57-
.. literalinclude:: ../flask_jwt_extended/jwt_manager.py
58-
:language: python
59-
:emphasize-lines: 60-122
60-
:linenos:
56+
..
57+
.. .. literalinclude:: ../flask_jwt_extended/jwt_manager.py
58+
.. :language: python
59+
.. :emphasize-lines: 60-122
60+
.. :linenos:

docs/documentation.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Documentation
2+
==============
3+
4+
Auto make / Refresh document changes
5+
6+
.. code-block:: bash
7+
8+
$ cd docs
9+
$ bash watchdocumentation.sh
10+
11+
12+
To clean & Compile documentation
13+
14+
.. code-block:: bash
15+
16+
$ make clean && make html

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Welcome to flask-jwt-extended's documentation!
2020
blacklist_and_token_revoking
2121
testing_and_coverage
2222

23+
documentation
2324

2425

2526

docs/options.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Configuration Options
2+
======================
3+
4+
.. literalinclude:: ../flask_jwt_extended/config.py
5+
:language: python
6+
7+
.. .. automodule:: flask_jwt_extended.config
8+
.. :members:

docs/watchdocumentation.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ watchmedo shell-command \
22
--patterns="*.rst" \
33
--ignore-pattern='_build/*' \
44
--recursive \
5-
--command='make html'
5+
--command='make clean && make html'

0 commit comments

Comments
 (0)