Skip to content

Commit 00167e4

Browse files
daveoncodedaveoncode
committed
sound sphinx doc structure
1 parent c465ec2 commit 00167e4

File tree

5 files changed

+53
-36
lines changed

5 files changed

+53
-36
lines changed

‎docs/errors.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Errors
2+
======
3+
4+
.. toctree::
5+
:maxdepth: 3
6+
7+
.. automodule:: string_utils.errors
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

‎docs/generation.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
String Generation
2+
=================
3+
4+
.. toctree::
5+
:maxdepth: 3
6+
7+
.. automodule:: string_utils.generation
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

‎docs/index.rst

Lines changed: 13 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,25 @@
11
Python String Utils Documentation
22
=================================
33

4-
.. toctree::
5-
:maxdepth: 3
6-
7-
8-
String Validation
9-
-----------------
10-
11-
.. automodule:: string_utils.validation
12-
:members:
13-
:undoc-members:
14-
:show-inheritance:
15-
16-
17-
String Manipulation
18-
-------------------
19-
20-
.. automodule:: string_utils.manipulation
21-
:members:
22-
:undoc-members:
23-
:show-inheritance:
24-
4+
Installing
5+
----------
256

26-
String Generation
27-
-----------------
7+
>>> pip install python-string-utils
288

29-
.. automodule:: string_utils.generation
30-
:members:
31-
:undoc-members:
32-
:show-inheritance:
339

10+
Modules
11+
-------
3412

35-
Exceptions
36-
----------
13+
.. toctree::
14+
:maxdepth: 3
3715

38-
.. automodule:: string_utils.errors
39-
:members:
40-
:undoc-members:
41-
:show-inheritance:
16+
validation
17+
manipulation
18+
generation
19+
errors
4220

4321

44-
Indices
45-
=======
22+
Function Indices
23+
----------------
4624

4725
* :ref:`genindex`
48-

‎docs/manipulation.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
String Manipulation
2+
===================
3+
4+
.. toctree::
5+
:maxdepth: 3
6+
7+
.. automodule:: string_utils.manipulation
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

‎docs/validation.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
String Validation
2+
=================
3+
4+
.. toctree::
5+
:maxdepth: 3
6+
7+
.. automodule:: string_utils.validation
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy