Skip to content

Docs config: add autoapi noindex and update README #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SmithSamuelM merged 1 commit into from
Mar 13, 2026
Merged

Docs config: add autoapi noindex and update README #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,18 @@ Current Status
================

Version 0.7.2
Added support for multiprocessing via multidoing.py
- Added support for multiprocessing via multidoing.py

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


Version 0.3.4
The async scheduler features should be pretty stable going forward.
The tcp library should also be stable going forward.

The TCP IO Client and Server classes are implemented. Includes support for TLS

TCP ServerDoer, EchoServerDoer, and ClientDoer classes are implemented as examples

- The async scheduler features should be pretty stable going forward.
- The tcp library should also be stable going forward.
- The TCP IO Client and Server classes are implemented. Includes support for TLS
- TCP ServerDoer, EchoServerDoer, and ClientDoer classes are implemented as examples
9 changes: 8 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#
import os
import sys
sys.path.insert(0, os.path.abspath('./../../src'))
sys.path.insert(0, os.path.abspath('./../..'))

import hio
Expand Down Expand Up @@ -44,7 +45,13 @@

napoleon_include_init_with_doc = True

autoapi_dirs = ['./../../src/']
autoapi_dirs = [os.path.abspath('./../../src/hio/base')]
autoapi_options = [
"members",
"undoc-members",
"show-inheritance",
"noindex",
]

if os.getenv('SPELLCHECK'):
extensions += 'sphinxcontrib.spelling',
Expand Down
4 changes: 4 additions & 0 deletions docs/source/hio.base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ hio.base.basing module
:members:
:undoc-members:
:show-inheritance:
:no-index:

hio.base.doing module
---------------------
Expand All @@ -19,6 +20,7 @@ hio.base.doing module
:members:
:undoc-members:
:show-inheritance:
:no-index:

hio.base.tyming module
----------------------
Expand All @@ -27,6 +29,7 @@ hio.base.tyming module
:members:
:undoc-members:
:show-inheritance:
:no-index:

Module contents
---------------
Expand All @@ -35,3 +38,4 @@ Module contents
:members:
:undoc-members:
:show-inheritance:
:no-index:
Loading