Change to support sphinx version 3

Previously sphinx version 2 was supported.  Now *only* sphinx version 3
is supported.  There are significant changes between sphinx 2 and sphinx
3 and there doesn't appear to be enough justification to keep supporting
sphinx 2.

closes: #6

Author: speedyleion

.github/workflows/pythonpackage.yml

@@ -21,13 +21,14 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install tox codecov
+
+        # Make libclang available for the parsing of the c files with the python clang package
+        sudo ln -s /usr/lib/x86_64-linux-gnu/libclang-6.0.so.1 /usr/lib/x86_64-linux-gnu/libclang.so
     - name: Test with tox
       env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         TOX_SKIP_ENV: py37$
       run: |
-        # Make libclang available for the parsing of the c files with the python clang package
-        sudo ln -s /usr/lib/x86_64-linux-gnu/libclang-6.0.so.1 /usr/lib/x86_64-linux-gnu/libclang.so
         tox
         cp tests/.coverage .
         codecov

CHANGELOG.rst

@@ -9,6 +9,12 @@ This project adheres to `Semantic Versioning <https://semver.org/>`_.
 `v0.3.0-dev`_ (unreleased)
 ==========================
 
+Changed
+-------
+
+* Changed to support sphinx version 3.  Due to significant changes between
+  sphinx 2 and 3, sphinx 2 is no longer supported.
+
 Fixes
 -----
 

docs/_api/sphinx_c_autodoc.clang.rst

@@ -20,7 +20,6 @@ sphinx\_c\_autodoc.clang.patches module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

docs/_api/sphinx_c_autodoc.domains.rst

@@ -12,7 +12,6 @@ sphinx\_c\_autodoc.domains.c module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

docs/_api/sphinx_c_autodoc.rst

@@ -5,6 +5,7 @@ Subpackages
 -----------
 
 .. toctree::
+   :maxdepth: 4
 
    sphinx_c_autodoc.clang
    sphinx_c_autodoc.domains
@@ -22,7 +23,6 @@ sphinx\_c\_autodoc.loader module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

docs/developer_notes.rst

@@ -14,8 +14,8 @@ AST:
     down of a C source file into its components. Normally an AST goes all the
     way down to things like if conditions and other constructs. However for
     the use in autodoc there is no reason to break down the contents of a
-    function. Structures, unions and enumerations are further broken down
-    into their member or enumeration constants though.
+    function. Structures, unions and enums are further broken down into their
+    member or enumerator constants though.
 
     For this extension the common AST is just a simple dictionary which has
     the following entries:

docs/directives.rst

@@ -57,13 +57,13 @@ instance from being added to the index provide this option.
 
             - They are in a header file, ends in `.h`. By nature header files are meant to
               be included in other files, thus anything declared there is
-              deamed public.
+              deemed public.
             - They can be visible outside of the compilation unit. These are
               things the linker can get access to. Mainly this means functions
               and variables that are not static.
 
         Just as for the standard `autodoc`_ options, one can use the negated
-        form of ``:no-private-members:`` to selectivly turn off this option
+        form of ``:no-private-members:`` to selectively turn off this option
         on a per module basis.
 
 .. rst:directive:: .. autocfunction:: filename::function
@@ -78,17 +78,16 @@ instance from being added to the index provide this option.
 
 .. rst:directive:: .. autocmacro:: filename::some_define
 
-    Document a C macro, or enumeration constant.
-
-    .. warning:: This should not be used for function like macros instead
-        utilize the ``.. autocfunction::`` directive.
+    Document a C macro.  Both macro constants as well as function like
+    macros.
 
 .. rst:directive:: .. autoctype:: filename::typedef
 
-    Document a typedef, struct, union, or enum.
+    Document a typedef
+
+.. rst:directive:: .. autocenum:: filename::enum_name
 
-    .. warning:: This should not be used for enumeration constants instead
-        utilize the ``.. autocmacro::`` directive.
+    Document a enum
 
     .. rst:directive:option:: members
 
@@ -102,9 +101,56 @@ instance from being added to the index provide this option.
           automatically documented.
         - Specified as ``:no-members:``, no members will be automatically
           documented.
-        - Specified with no arguments, ``:members:``, then all fields (if struct
-          or union) or all enumeration constants (if an enum) will be recursively
+        - Specified with no arguments, ``:members:``, then all enumerator
+          constants will be documented.
+        - Specified with a comma separated list of names,
+          ``:members: field_a, field_b``, only the items specified will be
+          recursively documented.
+
+.. rst:directive:: .. autocenumerator:: filename::enum_name.enumerator
+
+    Document a enumerator.  One of the constant values of an enum.
+
+.. rst:directive:: .. autocstruct:: filename::struct_name
+
+    Document a struct
+
+    .. rst:directive:option:: members
+
+        Specify which members to recursively document.
+
+        This option has 4 states:
+
+        - Omitted will result in the ``members`` entry of
+          `autodoc_default_options`_ being used. If ``members`` is omitted
+          from `autodoc_default_options`_ then no members will be
+          automatically documented.
+        - Specified as ``:no-members:``, no members will be automatically
           documented.
+        - Specified with no arguments, ``:members:``, then all fields will be
+          recursively documented.
+        - Specified with a comma separated list of names,
+          ``:members: field_a, field_b``, only the items specified will be
+          recursively documented.
+
+.. rst:directive:: .. autocunion:: filename::union_name
+
+    Document a union
+
+    .. rst:directive:option:: members
+
+        Specify which members to recursively document.
+
+        This option has 4 states:
+
+        - Omitted will result in the ``members`` entry of
+          `autodoc_default_options`_ being used. If ``members`` is omitted
+          from `autodoc_default_options`_ then no members will be
+          automatically documented.
+        - Specified as ``:no-members:``, no members will be automatically
+          documented.
+        - Specified with no arguments, ``:members:``, then all fields will be
+          recursively documented.
         - Specified with a comma separated list of names,
           ``:members: field_a, field_b``, only the items specified will be
           recursively documented.
@@ -115,8 +161,7 @@ instance from being added to the index provide this option.
 
 .. rst:directive:: .. autocmember:: filename::struct.field
 
-    Document the specified field (if a struct or union) or specified enumeration
-    constant (if an enum).
+    Document the specified field of a struct or union.
 
     .. note:: This is one of the overloaded uses of the term **member**. This
         name was used to keep consistent with the `member`_ wording of the

docs/napoleon.rst

@@ -20,7 +20,7 @@ Using this extension will take:
 
 and convert it into 
 
-.. autoctype:: example.c::members_documented_with_napoleon
+.. autocstruct:: example.c::members_documented_with_napoleon
     :members:
     :noindex:
 

setup.py

@@ -29,7 +29,7 @@
         "Source": "https://github.com/speedyleion/sphinx-c-autodoc",
     },
     install_requires=[
-        "sphinx>=2,<3",
+        "sphinx>=3",
         "clang>=6",
         "beautifulsoup4",
     ],