Skip to content

Commit

Permalink
fix sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
gilesknap committed Jul 17, 2023
1 parent 69d050e commit 1a727d5
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,15 @@
"sphinx.ext.viewcode",
# Adds the inheritance-diagram generation directive
"sphinx.ext.inheritance_diagram",
# Makes autodoc understand apischema annotated classes/functions
"sphinx_apischema",
# Add a copy button to each code block
"sphinx_copybutton",
# For the card element
"sphinx_design",
# for pydantic
"sphinx_autodoc_typehints",
]

# If true, Sphinx will warn about all references where the target cannot
# be found.
nitpicky = False
nitpicky = True

# A list of (type, target) tuples (by default empty) that should be ignored when
# generating warnings in "nitpicky mode". Note that type should include the
Expand All @@ -67,19 +63,19 @@
("py:class", "'object'"),
("py:class", "'id'"),
("py:class", "typing_extensions.Literal"),
("py:class", "type"),
]

# Both the class’ and the __init__ method’s docstring are concatenated and
# inserted into the main body of the autoclass directive
autoclass_content = "both"
# Dont use the __init__ docstring because pydantic base classes cause sphinx
# to generate a lot of warnings
autoclass_content = "class"

# Order the members by the order they appear in the source code
autodoc_member_order = "bysource"

# Don't inherit docstrings from baseclasses
autodoc_inherit_docstrings = False


# Output graphviz directive produced images in a scalable format
graphviz_output_format = "svg"

Expand Down

0 comments on commit 1a727d5

Please sign in to comment.