diff --git a/README.md b/README.md index 035a5efd..1da174dc 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/source/conf.py b/docs/source/conf.py index 543eadbc..6071a57e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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 @@ -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', diff --git a/docs/source/hio.base.rst b/docs/source/hio.base.rst index dc1b11ab..fce5bbd8 100644 --- a/docs/source/hio.base.rst +++ b/docs/source/hio.base.rst @@ -11,6 +11,7 @@ hio.base.basing module :members: :undoc-members: :show-inheritance: + :no-index: hio.base.doing module --------------------- @@ -19,6 +20,7 @@ hio.base.doing module :members: :undoc-members: :show-inheritance: + :no-index: hio.base.tyming module ---------------------- @@ -27,6 +29,7 @@ hio.base.tyming module :members: :undoc-members: :show-inheritance: + :no-index: Module contents --------------- @@ -35,3 +38,4 @@ Module contents :members: :undoc-members: :show-inheritance: + :no-index: