diff --git a/docs/conf.py b/docs/conf.py index 45dbb93e8c9c3de8dd43c1bb99ef15015a1c5b95..f742f90ee98625db38c22211d4012b7fa38b3408 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,13 +37,12 @@ extensions = [ "sphinx.ext.autosummary", "sphinx.ext.doctest", "sphinx.ext.intersphinx", - "sphinx.ext.mathjax", "sphinx.ext.extlinks", - "sphinxcontrib.apidoc", + # "sphinxcontrib.apidoc", # removed since only 1 module ] source_suffix = { - ".rst": "restructuredtext", + # ".rst": "restructuredtext", ".md": "markdown", } @@ -77,12 +76,12 @@ html_static_path = ["_static"] # -- Extensions -------------------------------------------------------------- # apidoc -apidoc_module_dir = "../ur_py_ctl" -apidoc_output_dir = "reference" -apidoc_excluded_paths = ["tests"] -apidoc_separate_modules = False -apidoc_toc_file = False -apidoc_module_first = True +# apidoc_module_dir = "../ur_py_ctl" +# apidoc_output_dir = "reference" +# apidoc_excluded_paths = ["tests"] +# apidoc_separate_modules = False +# apidoc_toc_file = False +# apidoc_module_first = True # # auto{summary,doc,class} autosummary_generate = True diff --git a/docs/index.md b/docs/index.md index 5903c3342c120598de437ee4a9f6bd4b4153a105..a28d972c46290e197e60a2bf2359b931fdf0d993 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,8 @@ -# Welcome to ur_py_ctl's documentation! +# Welcome to ur_py_ctl's documentation ```{toctree} --- -maxdepth: 1 +maxdepth: 2 caption: Contents --- installation diff --git a/docs/reference.md b/docs/reference.md index 1667a34faac359c69d7067b0d01520470548d9d8..5ea3acb193eb8e1a18dd685d05c48b3801b89bbb 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,10 +1,6 @@ # API Reference -```{toctree} ---- -maxdepth: 2 -titlesonly: -glob: ---- -reference/* +```{eval-rst} +.. automodule:: ur_py_ctl.urscript_commands + :members: ``` diff --git a/pyproject.toml b/pyproject.toml index 011e1c1e7727eb08d2b8d2ea5202470fd498a504..1c42e952d8861d640390aa4a4501efed0a8afbb1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,7 +21,6 @@ pre-commit = "^2.18.1" pytest = "^7.1.1" Sphinx = "^5.2.2" myst-parser = {extras = ["linkify"], version = "^0.18.1"} -sphinxcontrib-apidoc = "^0.3.0" sphinx-rtd-theme = "^1.0.0" isort = "^5.10.1"