Skip to content

Commit b217236

Browse files
committed
Compose index.rst to actually provide documentation
1 parent 9375dcc commit b217236

File tree

2 files changed

+63
-1
lines changed

2 files changed

+63
-1
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
4040
# ones.
4141
extensions = [
42+
'sphinx.ext.autodoc',
4243
'sphinx.ext.githubpages',
4344
]
4445

docs/index.rst

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,79 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6+
.. This file is also inspired by
7+
https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example
8+
69
Welcome to MSAL Python's documentation!
710
=======================================
811

912
.. toctree::
1013
:maxdepth: 2
1114
:caption: Contents:
1215

16+
You can find high level conceptual documentations in the project
17+
`README <https://github.com/AzureAD/microsoft-authentication-library-for-python>`_
18+
and
19+
`workable samples inside the project code base
20+
<https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample>`_
21+
.
22+
23+
The documentation hosted here is for API Reference.
24+
25+
26+
PublicClientApplication and ConfidentialClientApplication
27+
=========================================================
28+
29+
MSAL proposes a clean separation between
30+
`public client applications and confidential client applications
31+
<https://tools.ietf.org/html/rfc6749#section-2.1>`_.
32+
33+
They are implemented as two separated classes,
34+
with different methods for different authentication scenarios.
35+
36+
PublicClientApplication
37+
-----------------------
38+
.. autoclass:: msal.PublicClientApplication
39+
:members:
40+
41+
ConfidentialClientApplication
42+
-----------------------------
43+
.. autoclass:: msal.ConfidentialClientApplication
44+
:members:
45+
46+
47+
Shared Methods
48+
--------------
49+
Both PublicClientApplication and ConfidentialClientApplication
50+
have following methods inherited from their base class.
51+
You typically do not need to initiate this base class, though.
52+
53+
.. autoclass:: msal.ClientApplication
54+
:members:
55+
56+
.. automethod:: __init__
57+
58+
59+
TokenCache
60+
==========
61+
62+
One of the parameter accepted by
63+
both `PublicClientApplication` and `ConfidentialClientApplication`
64+
is the `TokenCache`.
65+
66+
.. autoclass:: msal.TokenCache
67+
:members:
68+
69+
You can subclass it to add new behavior, such as, token serialization.
70+
See `SerializableTokenCache` for example.
71+
72+
.. autoclass:: msal.SerializableTokenCache
73+
:members:
1374

1475

1576
Indices and tables
1677
==================
1778

1879
* :ref:`genindex`
19-
* :ref:`modindex`
2080
* :ref:`search`
81+

0 commit comments

Comments
 (0)