Skip to content

Commit

Permalink
Sphinx: Generate class doc from class and init (OSGeo#2317)
Browse files Browse the repository at this point in the history
By default, only class doc is used to document class and `__init__` is ignored. This uses both to create the doc in Sphinx. Parameters can then be documented with the function as for any other function.
  • Loading branch information
wenzeslaus authored Apr 20, 2022
1 parent e4100c8 commit 9c4ded9
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions python/grass/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -421,3 +421,6 @@

# If false, no index is generated.
# epub_use_index = True

# Where class documentation comes from (class or __init__ docstring).
autoclass_content = "both"

0 comments on commit 9c4ded9

Please sign in to comment.