Skip to content

Commit 405bc52

Browse files
Jay-Alexander ElliotJay-Alexander Elliot
authored andcommitted
Adjust docs indexing and overlap handling
1 parent 107bc50 commit 405bc52

9 files changed

Lines changed: 29 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,9 @@ Version 0.7.2
6363
- Added support for multiprocessing via multidoing.py
6464

6565
Version 0.4.1
66-
- Refined Doist and DoDoer makes their protocol interfaces nearly identical as
67-
is reasonably practical
66+
- Refined Doist and DoDoer makes their protocol interfaces nearly identical as is reasonably practical
6867
- Added HTTP support with hio compatible HTTP Client and HTTP WSGI Server
69-
- Example test code shows HTTP Server working with Falcon and Bottle ReST Micro
70-
frameworks
68+
- Example test code shows HTTP Server working with Falcon and Bottle ReST Micro frameworks
7169

7270

7371
Version 0.3.4

‎docs/source/conf.py‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,22 @@
3636
extensions = [
3737
'myst_parser',
3838
'sphinx.ext.napoleon',
39-
'sphinx.ext.viewcode',
4039
'sphinx.ext.autosummary',
4140
'sphinx.ext.autodoc',
4241
'autoapi.extension',
4342
"sphinx_rtd_theme",
4443
]
4544

45+
# Work around a Sphinx viewcode crash on Python 3.14 during collect_pages.
46+
# Keep viewcode enabled on earlier Python versions.
47+
if sys.version_info < (3, 14):
48+
extensions.append('sphinx.ext.viewcode')
49+
4650
napoleon_include_init_with_doc = True
4751

48-
autoapi_dirs = [os.path.abspath('./../../src/hio/base')]
52+
autoapi_dirs = [os.path.abspath('./../../src/hio')]
4953
autoapi_options = [
5054
"members",
51-
"undoc-members",
5255
"show-inheritance",
5356
"noindex",
5457
]
@@ -66,7 +69,7 @@
6669
# List of patterns, relative to source directory, that match files and
6770
# directories to ignore when looking for source files.
6871
# This pattern also affects html_static_path and html_extra_path.
69-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
72+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'test.md']
7073

7174

7275
# -- Options for HTML output -------------------------------------------------

‎docs/source/hio.core.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ hio.core.coring module
2121
:members:
2222
:undoc-members:
2323
:show-inheritance:
24+
:no-index:
2425

2526
hio.core.wiring module
2627
----------------------
@@ -29,6 +30,7 @@ hio.core.wiring module
2930
:members:
3031
:undoc-members:
3132
:show-inheritance:
33+
:no-index:
3234

3335
Module contents
3436
---------------
@@ -37,3 +39,4 @@ Module contents
3739
:members:
3840
:undoc-members:
3941
:show-inheritance:
42+
:no-index:

‎docs/source/hio.core.serial.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ hio.core.serial.serialing module
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
14+
:no-index:
1415

1516
Module contents
1617
---------------
@@ -19,3 +20,4 @@ Module contents
1920
:members:
2021
:undoc-members:
2122
:show-inheritance:
23+
:no-index:

‎docs/source/hio.core.tcp.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ hio.core.tcp.clienting module
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
14+
:no-index:
1415

1516
hio.core.tcp.serving module
1617
---------------------------
@@ -19,6 +20,7 @@ hio.core.tcp.serving module
1920
:members:
2021
:undoc-members:
2122
:show-inheritance:
23+
:no-index:
2224

2325
hio.core.tcp.tcping module
2426
--------------------------
@@ -27,6 +29,7 @@ hio.core.tcp.tcping module
2729
:members:
2830
:undoc-members:
2931
:show-inheritance:
32+
:no-index:
3033

3134
Module contents
3235
---------------
@@ -35,3 +38,4 @@ Module contents
3538
:members:
3639
:undoc-members:
3740
:show-inheritance:
41+
:no-index:

‎docs/source/hio.core.udp.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ hio.core.udp.udping module
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
14+
:no-index:
1415

1516
Module contents
1617
---------------
@@ -19,3 +20,4 @@ Module contents
1920
:members:
2021
:undoc-members:
2122
:show-inheritance:
23+
:no-index:

‎docs/source/hio.demo.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Module contents
88
:members:
99
:undoc-members:
1010
:show-inheritance:
11+
:no-index:

‎docs/source/hio.help.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ hio.help.helping module
1111
:members:
1212
:undoc-members:
1313
:show-inheritance:
14+
:no-index:
1415

1516
hio.help.ogling module
1617
----------------------
@@ -19,6 +20,7 @@ hio.help.ogling module
1920
:members:
2021
:undoc-members:
2122
:show-inheritance:
23+
:no-index:
2224

2325
hio.help.timing module
2426
----------------------
@@ -27,6 +29,7 @@ hio.help.timing module
2729
:members:
2830
:undoc-members:
2931
:show-inheritance:
32+
:no-index:
3033

3134
Module contents
3235
---------------
@@ -35,3 +38,4 @@ Module contents
3538
:members:
3639
:undoc-members:
3740
:show-inheritance:
41+
:no-index:

‎docs/source/hio.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ hio.cli module
2222
:members:
2323
:undoc-members:
2424
:show-inheritance:
25+
:no-index:
2526

2627
hio.daemon module
2728
-----------------
@@ -30,6 +31,7 @@ hio.daemon module
3031
:members:
3132
:undoc-members:
3233
:show-inheritance:
34+
:no-index:
3335

3436
hio.hioing module
3537
-----------------
@@ -38,6 +40,7 @@ hio.hioing module
3840
:members:
3941
:undoc-members:
4042
:show-inheritance:
43+
:no-index:
4144

4245
Module contents
4346
---------------
@@ -46,3 +49,4 @@ Module contents
4649
:members:
4750
:undoc-members:
4851
:show-inheritance:
52+
:no-index:

0 commit comments

Comments
 (0)