Use Autoapi instead of Autodoc to generate Python docs

Autoapi uses a custom parser to read in the doc strings and doesn't need
to include the python modules.
This allows to generate the docs even without full build of the library,
we just need to run swig but there is no need to compile the library
with the swig layer to create working Python module.

dnf5.spec

@@ -105,6 +105,7 @@ BuildRequires:  pkgconfig(zck) >= %{zchunk_version}
 BuildRequires:  python3dist(breathe)
 BuildRequires:  python3dist(sphinx) >= 4.1.2
 BuildRequires:  python3dist(sphinx-rtd-theme)
+BuildRequires:  python3dist(sphinx-autoapi)
 %endif
 
 %if %{with sanitizers}

doc/api/python/libdnf5_base_base.rst

@@ -2,5 +2,5 @@ Base
 ====
 
 
-.. autoclass:: libdnf5.base.Base
+.. autoapiclass:: libdnf5.base.Base
     :members:

doc/api/python/libdnf5_base_goal.rst

@@ -2,5 +2,5 @@ Goal
 ====
 
 
-.. autoclass:: libdnf5.base.Goal
+.. autoapiclass:: libdnf5.base.Goal
     :members:

doc/api/python/libdnf5_repo_repo_query.rst

@@ -2,5 +2,5 @@ RepoQuery
 =========
 
 
-.. autoclass:: libdnf5.repo.RepoQuery
+.. autoapiclass:: libdnf5.repo.RepoQuery
     :members:

doc/api/python/libdnf5_rpm_package.rst

@@ -1,12 +1,12 @@
 Package
 =======
 
-.. autoclass:: libdnf5.rpm.Package
+.. autoapiclass:: libdnf5.rpm.Package
     :members:
 
 
 Checksum
 --------
 
-.. autoclass:: libdnf5.rpm.Checksum
+.. autoapiclass:: libdnf5.rpm.Checksum
     :members:

doc/api/python/libdnf5_rpm_package_query.rst

@@ -2,5 +2,5 @@ PackageQuery
 ============
 
 
-.. autoclass:: libdnf5.rpm.PackageQuery
+.. autoapiclass:: libdnf5.rpm.PackageQuery
     :members:

doc/conf.py.in

@@ -20,7 +20,6 @@ except NameError:
     libdnf_docdir = os.path.abspath(".")
 
 sys.path.insert(0, os.path.join(libdnf_docdir, "sphinx"))
-sys.path.insert(0, os.path.join(libdnf_docdir, "../bindings/python3"))
 
 # -- Project information -----------------------------------------------------
 
@@ -40,11 +39,26 @@ needs_sphinx = '4.1.2'
 # ones.
 extensions = [
     'breathe',
+    'autoapi.extension',
+    # In order to use directives (autoapiclass) we need autodoc extension:
+    # https://sphinx-autoapi.readthedocs.io/en/latest/reference/directives.html
     'sphinx.ext.autodoc',
 ]
 breathe_projects = {'dnf5': '@CMAKE_CURRENT_BINARY_DIR@/xml/'}
 breathe_default_project = 'dnf5'
 
+autoapi_type = 'python'
+autoapi_dirs = ['@CMAKE_CURRENT_BINARY_DIR@/../bindings/python3/libdnf5', '@CMAKE_CURRENT_BINARY_DIR@/../bindings/python3/libdnf5_cli']
+autoapi_root = "api/python/autoapi"
+autoapi_python_use_implicit_namespaces = True
+
+# We don't want to automatically generate the full documentation.
+# Instead we use directives, this allows greater control and both
+# cpp and python docs can have the same look and layout.
+autoapi_generate_api_docs = False
+autoapi_add_toctree_entry = False
+autoapi_add_objects_to_toctree = False
+
 if sphinx.version_info[:3] > (4, 0, 0):
     tags.add('sphinx4')
     extensions += ['dbusdoc']

doc/requirements.txt

@@ -1 +1,2 @@
 breathe
+sphinx-autoapi