Skip to content

Commit 691e288

Browse files
DirectXMan12frozencemetery
authored andcommitted
Docs: ToC Tweaks
This commit bumps the docs theme version to get support for deeper nesting on the nav bar. It increases the ToC depth to 3, and hides the ToC from the intro page to avoid redundancy. New headings were added to the high-level API docs to take advantage of the increased ToC depth.
1 parent 8977e77 commit 691e288

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

docs-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Sphinx >= 1.3.1
2-
sphinx-rtd-theme >= 0.1.7
2+
sphinx-rtd-theme >= 0.1.9
33
sphinxcontrib-napoleon >= 0.2.8

docs/source/gssapi.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,23 @@ representing the primary abstractions that GSSAPI provides:
2121
Main Classes
2222
------------
2323

24+
Names
25+
"""""
26+
2427
.. automodule:: gssapi.names
2528
:members:
2629
:undoc-members:
2730

31+
Credentials
32+
"""""""""""
33+
2834
.. automodule:: gssapi.creds
2935
:members:
3036
:undoc-members:
3137

38+
Security Contexts
39+
"""""""""""""""""
40+
3241
.. automodule:: gssapi.sec_contexts
3342
:members:
3443
:undoc-members:

docs/source/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,9 @@ corresponding C functions. The high-level API makes use of the low-level API
1919
to access underlying GSSAPI functionality. Additionally certain extensions
2020
are currently only available from the low-level API.
2121

22-
Contents:
23-
2422
.. toctree::
25-
:maxdepth: 2
23+
:hidden:
24+
:maxdepth: 3
2625

2726
gssapi.rst
2827
gssapi.raw.rst

0 commit comments

Comments
 (0)