From 0a37f1f37e587c89c026c53c1baaf3e80284ba56 Mon Sep 17 00:00:00 2001 From: alhendrickson <159636032+alhendrickson@users.noreply.github.com.> Date: Thu, 3 Jul 2025 11:34:28 +0000 Subject: [PATCH] docs(medcat-v2): Fix API Reference page not showing for medcat v2 --- medcat-v2/docs/Makefile | 3 +++ .../docs/_templates/autoapi_templates/index.rst | 15 --------------- medcat-v2/docs/conf.py | 1 - medcat-v2/docs/requirements.txt | 3 +++ 4 files changed, 6 insertions(+), 16 deletions(-) delete mode 100644 medcat-v2/docs/_templates/autoapi_templates/index.rst diff --git a/medcat-v2/docs/Makefile b/medcat-v2/docs/Makefile index d4bb2cbb9..4a0f6fc5a 100644 --- a/medcat-v2/docs/Makefile +++ b/medcat-v2/docs/Makefile @@ -18,3 +18,6 @@ help: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +watch: + sphinx-autobuild . build/ diff --git a/medcat-v2/docs/_templates/autoapi_templates/index.rst b/medcat-v2/docs/_templates/autoapi_templates/index.rst deleted file mode 100644 index b2ab5cb22..000000000 --- a/medcat-v2/docs/_templates/autoapi_templates/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -API Reference -============= - -Auto-generated API reference documentation [#f1]_. - -.. toctree:: - :titlesonly: - - {% for page in pages %} - {% if page.top_level_object and page.display %} - {{ page.include_path }} - {% endif %} - {% endfor %} - -.. [#f1] Created with `sphinx-autoapi `_ diff --git a/medcat-v2/docs/conf.py b/medcat-v2/docs/conf.py index 1414c26b8..19c96c0ea 100644 --- a/medcat-v2/docs/conf.py +++ b/medcat-v2/docs/conf.py @@ -43,7 +43,6 @@ autoapi_type = 'python' autoapi_dirs = ['../medcat'] autodoc_typehints = 'description' -autoapi_template_dir = '_templates/autoapi_templates' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/medcat-v2/docs/requirements.txt b/medcat-v2/docs/requirements.txt index edd4090a5..50b27ea7a 100644 --- a/medcat-v2/docs/requirements.txt +++ b/medcat-v2/docs/requirements.txt @@ -2,6 +2,9 @@ sphinx~=8.1.3 sphinx-rtd-theme~=3.0.2 myst-parser~=4.0.1 sphinx-autoapi~=3.6.0 +sphinx-autobuild + +# Are the below needed? numpy==2.0.2 dill==0.3.9 pandas==2.2.3