Skip to content

Commit

Permalink
doc: Generate docs for undocummented functions so they at least show up
Browse files Browse the repository at this point in the history
This is alread done in AutoAPI by default (used in readthedocs for
python API).
  • Loading branch information
kontura committed Oct 24, 2023
1 parent 030ecf5 commit 0c34c3a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@ extensions = [
breathe_projects = {'dnf5': '@CMAKE_CURRENT_BINARY_DIR@/xml/'}
breathe_default_project = 'dnf5'

# Show undocumented members for both C++ and Python API docs
breathe_default_members = ('members', 'undoc-members')
autodoc_default_options = {
'undoc-members': True,
}

# The autoapi config is only used doc/setup.py in readthedocs workflow (not by cmake)
autoapi_type = 'python'
autoapi_dirs = ['@CMAKE_CURRENT_BINARY_DIR@/../bindings/python3/libdnf5', '@CMAKE_CURRENT_BINARY_DIR@/../bindings/python3/libdnf5_cli']
Expand Down

0 comments on commit 0c34c3a

Please sign in to comment.