Skip to content

Commit

Permalink
docs: Use autodoc_default_options
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Oct 4, 2023
1 parent 0857fdb commit 9176808
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
3 changes: 1 addition & 2 deletions agate/data_types/date.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ def cast(self, d):
If both `date_format` and `locale` have been specified
in the `agate.Date` instance, the `cast()` function
is not thread-safe.
:returns:
:class:`datetime.date` or :code:`None`.
:returns: :class:`datetime.date` or :code:`None`.
"""
if type(d) is date or d is None:
return d
Expand Down
3 changes: 1 addition & 2 deletions agate/data_types/date_time.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@ def cast(self, d):
If both `date_format` and `locale` have been specified
in the `agate.DateTime` instance, the `cast()` function
is not thread-safe.
:returns:
:class:`datetime.datetime` or :code:`None`.
:returns: :class:`datetime.datetime` or :code:`None`.
"""
if isinstance(d, datetime.datetime) or d is None:
return d
Expand Down
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@

htmlhelp_basename = 'agatedoc'

autodoc_default_flags = ['members', 'show-inheritance']
autodoc_default_options = {
'members': None,
'show-inheritance': True,
}

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
Expand Down

0 comments on commit 9176808

Please sign in to comment.