Improved documentation

Author: pcisar

docs/_static/basic.css

@@ -681,3 +681,23 @@ span.changed {
     padding: 5px;
 }
 
+dl.class, dl.exception, dl.data, dl.function {
+/*    background: #fbe3e4 ;*/
+    border: 1px solid grey;
+    border-top-style: none;
+    border-left-style: none;
+    border-right-style: none;
+/*    padding: 3px;*/
+}
+
+dt.py {
+    background: #f8f8f8;
+/*    border: 2px solid #aacc99;*/
+/*    border: 2px solid #ffcccc;  /*#ffd324;*/
+/*    border: 2px solid #fbc2c4;*/
+    border: 1px solid #e1e1e8;
+    border-top-style: none;
+    border-left-style: none;
+/*    border-right-style: none; */
+    padding: 2px 5px;
+}

docs/buffer.txt

@@ -13,19 +13,11 @@ data of various data type.
 
 MemoryBuffer
 ============
-
 .. autoclass:: MemoryBuffer
 
 Buffer factories
 ================
-
 .. autoclass:: BufferFactory
-
--------------
-
 .. autoclass:: BytesBufferFactory
-
---------------
-
 .. autoclass:: CTypesBufferFactory
 

docs/changelog.txt

@@ -10,6 +10,12 @@ Changelog
   - Added internal functions `_decompose` and `_power_of_two` from stdlib `.enum` module,
     because they were removed in Python 3.11.
 
+* `~firebird.base.protobuf` module:
+
+  - Use :ref:`importlib.metadata.entry_points <entry-points>` instead `pkg_resources.iter_entry_points`.
+
+* Improved documentation.
+
 Version 1.4.2
 =============
 

docs/collections.txt

@@ -40,20 +40,12 @@ Types for type hints & annotations
 
 Collections
 ===========
-
 .. autoclass:: BaseObjectCollection
-
---------
-
 .. autoclass:: DataList
-
---------
-
 .. autoclass:: Registry
 
 Functions
 =========
-
 .. autofunction:: make_lambda
 
 

docs/config.txt

@@ -326,107 +326,38 @@ Application Directory Scheme
 .. versionchanged:: 1.2.0
 
 .. autoclass:: DirectoryScheme
-
------
-
 .. autoclass:: WindowsDirectoryScheme
-
------
-
 .. autoclass:: LinuxDirectoryScheme
-
------
-
 .. autoclass:: MacOSDirectoryScheme
-
------
-
 .. autofunction:: get_directory_scheme
 
 Config
 ======
-
 .. autoclass:: Config
 
 Options
 =======
-
 .. autoclass:: Option
-
------
-
 .. autoclass:: StrOption
-
------
-
 .. autoclass:: IntOption
-
------
-
 .. autoclass:: FloatOption
-
------
-
 .. autoclass:: DecimalOption
-
------
-
 .. autoclass:: BoolOption
-
------
-
 .. autoclass:: ZMQAddressOption
-
------
-
 .. autoclass:: EnumOption
-
------
-
 .. autoclass:: FlagOption
-
------
-
 .. autoclass:: UUIDOption
-
------
-
 .. autoclass:: MIMEOption
-
------
-
 .. autoclass:: ListOption
-
------
-
 .. autoclass:: DataclassOption
-
------
-
 .. autoclass:: PathOption
-
------
-
 .. autoclass:: PyExprOption
-
------
-
 .. autoclass:: PyCodeOption
-
------
-
 .. autoclass:: PyCallableOption
-
------
-
 .. autoclass:: ConfigOption
-
------
-
 .. autoclass:: ConfigListOption
 
 Functions
 =========
-
 .. autofunction:: create_config
 

docs/hooks.txt

@@ -142,19 +142,9 @@ Output from sample code::
 
 Functions
 =========
-
 .. autofunction:: register_class
-
--------------
-
 .. autofunction:: register_name
-
---------
-
 .. autofunction:: add_hook
-
--------------
-
 .. autofunction:: get_callbacks
 
 Classes

docs/logging.txt

@@ -282,43 +282,26 @@ The following program is an example of small but complex enough code that you ca
 
 Enums & Flags
 =============
-
 .. autoclass:: LogLevel
-
---------
-
 .. autoclass:: BindFlag
 
 Functions
 =========
-
 .. autofunction:: bind_logger
-
-----------
-
 .. autofunction:: get_logger
-
---------------
-
 .. autofunction:: get_logging_id
-
--------------------
-
 .. autofunction:: install_null_logger
 
 Logger adapter
 ==============
-
 .. autoclass:: FBLoggerAdapter
 
 Logging manager
 ===============
-
 .. autoclass:: LoggingManager
 
 Mixins
 ======
-
 .. autoclass:: LoggingIdMixin
 
 Globals

docs/protobuf.txt

@@ -13,52 +13,31 @@ The generated `*_pb2.py` protobuf files could be registered using `register_decr
 or `load_registered` function. The registry could be then used to obtain information
 about protobuf messages or enum types, or to create message instances or enum values.
 
-Functions
+Constants
 =========
+.. autodata:: PROTO_EMPTY
+.. autodata:: PROTO_ANY
+.. autodata:: PROTO_DURATION
+.. autodata:: PROTO_TIMESTAMP
+.. autodata:: PROTO_STRUCT
+.. autodata:: PROTO_VALUE
+.. autodata:: PROTO_LISTVALUE
+.. autodata:: PROTO_FIELDMASK
 
+Functions
+=========
 .. autofunction:: register_decriptor
-
----------------
-
 .. autofunction:: load_registered
-
------------------
-
 .. autofunction:: is_msg_registered
-
-------------------
-
 .. autofunction:: is_enum_registered
-
--------------
-
 .. autofunction:: get_enum_type
-
--------------------
-
 .. autofunction:: get_enum_value_name
-
---------------
-
 .. autofunction:: create_message
-
--------------------
-
 .. autofunction:: get_enum_field_type
-
------------
-
 .. autofunction:: struct2dict
-
------------
-
 .. autofunction:: dict2struct
 
 Data classes
 ============
-
 .. autoclass:: ProtoMessageType
-
--------------
-
 .. autoclass:: ProtoEnumType