Skip to content

Commit 1b7db8d

Browse files
committed
Add more sections into TOC for the now long doc
1 parent 7aa2078 commit 1b7db8d

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

docs/index.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
MSAL Python documentation
1+
MSAL Python Documentation
22
=========================
33

44
.. toctree::
55
:maxdepth: 2
66
:caption: Contents:
77
:hidden:
88

9-
MSAL Documentation <https://docs.microsoft.com/en-au/azure/active-directory/develop/msal-authentication-flows>
10-
GitHub Repository <https://github.com/AzureAD/microsoft-authentication-library-for-python>
9+
index
10+
11+
..
12+
Comment: Perhaps because of the theme, only the first level sections will show in TOC,
13+
regardless of maxdepth setting.
1114
1215
You can find high level conceptual documentations in the project
1316
`README <https://github.com/AzureAD/microsoft-authentication-library-for-python>`_.
@@ -58,8 +61,8 @@ MSAL Python supports some of them.
5861
<https://github.com/AzureAD/microsoft-authentication-library-for-python/tree/dev/sample>`_.
5962

6063

61-
API
62-
===
64+
API Reference
65+
=============
6366

6467
The following section is the API Reference of MSAL Python.
6568
The API Reference is like a dictionary. You **read this API section when and only when**:
@@ -88,8 +91,10 @@ MSAL proposes a clean separation between
8891
They are implemented as two separated classes,
8992
with different methods for different authentication scenarios.
9093

94+
95+
9196
PublicClientApplication
92-
-----------------------
97+
=======================
9398

9499
.. autoclass:: msal.PublicClientApplication
95100
:members:
@@ -98,7 +103,7 @@ PublicClientApplication
98103
.. automethod:: __init__
99104

100105
ConfidentialClientApplication
101-
-----------------------------
106+
=============================
102107

103108
.. autoclass:: msal.ConfidentialClientApplication
104109
:members:
@@ -107,7 +112,7 @@ ConfidentialClientApplication
107112
.. automethod:: __init__
108113

109114
TokenCache
110-
----------
115+
==========
111116

112117
One of the parameters accepted by
113118
both `PublicClientApplication` and `ConfidentialClientApplication`

0 commit comments

Comments
 (0)