diff --git a/docs/conf.py b/docs/conf.py index 9fc0ca4..93b89fa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -8,7 +8,7 @@ sys.path.insert(0, os.path.abspath("../")) -# -- Project information ----------------------------------------------------- +# -- Project information ------------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "MessageCipher" @@ -16,7 +16,7 @@ copyright = "2023, Harrison Parkes" author = "Harrison Parkes" -# -- General configuration --------------------------------------------------- +# -- General configuration ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = ["sphinx.ext.autodoc"] @@ -25,8 +25,13 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] autodoc_typehints = "both" -# -- Options for HTML output ------------------------------------------------- +# -- Options for HTML output --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "sphinx_rtd_theme" html_static_path = ["_static"] + +# -- Options for autodoc extension --------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html + +autodoc_class_signature = "separated"