Skip to content

Commit

Permalink
Fix docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
albireox committed Sep 13, 2024
1 parent bcfec31 commit c1adf54
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/sphinx/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Devices
Spectrographs
^^^^^^^^^^^^^

.. automodule:: lvmopstools.devices.spectrograph
.. automodule:: lvmopstools.devices.specs
:members:

Ion Pumps
Expand Down
10 changes: 6 additions & 4 deletions docs/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.autosummary",
"sphinx_autodoc_typehints",
# "sphinx_autodoc_typehints",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx.ext.mathjax",
Expand Down Expand Up @@ -103,10 +103,12 @@
autodoc_mock_imports = ["_tkinter"]
autodoc_member_order = "groupwise"
autodoc_default_options = {"members": None, "show-inheritance": None}
# autodoc_typehints = "description"
# autodoc_typehints = "none"

simplify_optional_unions = True
typehints_use_signature_return = True
# typehints_use_signature = True
# typehints_use_signature_return = True
# always_use_bars_union = True
# simplify_optional_unions = True

# napoleon_use_rtype = False
# napoleon_use_ivar = True
Expand Down

0 comments on commit c1adf54

Please sign in to comment.