diff --git a/docs/.gitignore b/docs/.gitignore index 91fe08f..1320f90 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1 @@ - -site/ +site diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 3394556..0b381f9 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -45,9 +45,16 @@ nav: - CogStack AI: - CogStack AI: cogstack-ai/index.md - Natural Language Processing: overview/Natural Language Processing.md - - MedCAT: https://docs.cogstack.org/projects/nlp - - MedCAT Trainer: https://docs.cogstack.org/projects/medcat-trainer/ - - Tutorials: + - MedCAT: + - MedCAT: medcat/medcat-v2/docs/index.md + - Architecture: medcat/medcat-v2/docs/architecture.md + - Tutorials: '!import https://github.com/CogStack/cogstack-nlp?branch=main&docs_dir=medcat-v2-tutorials/notebooks/*&config=medcat-v2-tutorials/mkdocs.yml' + - Upgrading: + - Migration guide (v2): medcat/medcat-v2/docs/migration_guide_v2.md + - Breaking changes: medcat/medcat-v2/docs/breaking_changes.md + - API Reference: https://docs.cogstack.org/projects/nlp/en/latest/reference/medcat/ + - Medcat Trainer: '!import https://github.com/CogStack/cogstack-nlp?branch=main&docs_dir=medcat-trainer/docs/*&config=medcat-trainer/mkdocs.yml' + - Medcat Service: - Medcat Service Tutorial: platform/cogstack-ai/medcat-service-tutorial.ipynb - Data Engineering: - Data Engineering: data-engineering/index.md @@ -102,6 +109,14 @@ nav: - Understanding Metrics: platform/observability/reference/understanding-metrics.md plugins: + - multirepo: + cleanup: true + keep_docs_dir: false + nav_repos: + - name: medcat + import_url: https://github.com/CogStack/cogstack-nlp?branch=main + imports: + - medcat-v2/docs - search - macros - gen-files: diff --git a/docs/pyproject.toml b/docs/pyproject.toml index 111d446..071ec5b 100644 --- a/docs/pyproject.toml +++ b/docs/pyproject.toml @@ -9,6 +9,8 @@ dependencies = [ "mkdocs-gen-files>=0.6.1", "mkdocs-jupyter>=0.26.1", "mkdocs-material>=9.7.0", + "mkdocs-monorepo-plugin>=1.1.0", + "mkdocs-multirepo-plugin>=0.8.3", "termynal>=0.13.1", ] diff --git a/docs/uv.lock b/docs/uv.lock index 5d94c77..06d2924 100644 --- a/docs/uv.lock +++ b/docs/uv.lock @@ -288,6 +288,8 @@ dependencies = [ { name = "mkdocs-jupyter" }, { name = "mkdocs-macros-plugin" }, { name = "mkdocs-material" }, + { name = "mkdocs-monorepo-plugin" }, + { name = "mkdocs-multirepo-plugin" }, { name = "termynal" }, ] @@ -302,6 +304,8 @@ requires-dist = [ { name = "mkdocs-jupyter", specifier = ">=0.26.1" }, { name = "mkdocs-macros-plugin", specifier = ">=1.3.0" }, { name = "mkdocs-material", specifier = ">=9.7.0" }, + { name = "mkdocs-monorepo-plugin", specifier = ">=1.1.0" }, + { name = "mkdocs-multirepo-plugin", specifier = ">=0.8.3" }, { name = "ruff", marker = "extra == 'dev'", specifier = ">=0.12.11" }, { name = "termynal", specifier = ">=0.13.1" }, ] @@ -325,6 +329,15 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/60/97/891a0971e1e4a8c5d2b20bbe0e524dc04548d2307fee33cdeba148fd4fc7/comm-0.2.3-py3-none-any.whl", hash = "sha256:c615d91d75f7f04f095b30d1c1711babd43bdc6419c1be9886a85f2f4e489417", size = 7294, upload-time = "2025-07-25T14:02:02.896Z" }, ] +[[package]] +name = "dacite" +version = "1.9.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/55/a0/7ca79796e799a3e782045d29bf052b5cde7439a2bbb17f15ff44f7aacc63/dacite-1.9.2.tar.gz", hash = "sha256:6ccc3b299727c7aa17582f0021f6ae14d5de47c7227932c47fec4cdfefd26f09", size = 22420, upload-time = "2025-02-05T09:27:29.757Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/94/35/386550fd60316d1e37eccdda609b074113298f23cef5bddb2049823fe666/dacite-1.9.2-py3-none-any.whl", hash = "sha256:053f7c3f5128ca2e9aceb66892b1a3c8936d02c686e707bee96e19deef4bc4a0", size = 16600, upload-time = "2025-02-05T09:27:24.345Z" }, +] + [[package]] name = "debugpy" version = "1.8.20" @@ -930,6 +943,43 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960/mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31", size = 8728, upload-time = "2023-11-22T19:09:43.465Z" }, ] +[[package]] +name = "mkdocs-monorepo-plugin" +version = "1.1.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mkdocs" }, + { name = "python-slugify" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d4/6a/a75245020e44beb9d7c806158f8a2cda37597711409d40c5a37c70078a7e/mkdocs-monorepo-plugin-1.1.2.tar.gz", hash = "sha256:09200bcf837ad35070e6da973aa0cb682e69ed6e16f254a30584550c6d2d8ebb", size = 13723, upload-time = "2025-06-05T19:09:45.042Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/57/26/4f4c19457d1d4e6d571a3b092921b7a0ce9477d18d997755ac615d72b96b/mkdocs_monorepo_plugin-1.1.2-py3-none-any.whl", hash = "sha256:4b917bc224b89e34e1736bb31ad5ae9deb0a907da879e03bb9454b41fb8b1cac", size = 14539, upload-time = "2025-06-05T19:09:43.74Z" }, +] + +[[package]] +name = "mkdocs-multirepo-plugin" +version = "0.8.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "dacite" }, + { name = "mkdocs" }, + { name = "python-slugify" }, + { name = "typing-inspect" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/98/3b/ef032e99788315b898171262df8c685bbba4b7dd91f88de61a8f574d4667/mkdocs_multirepo_plugin-0.8.3.tar.gz", hash = "sha256:c474fe29dc9f8fc73c27c133fe378c240fd98f79ca1b9b46575f83af9a1f2559", size = 21352, upload-time = "2024-08-13T12:57:02.027Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/32/26/c0fb3e12b53da7969369a86872054ad11c3ef4d8276206c7b0cba33bb848/mkdocs_multirepo_plugin-0.8.3-py2.py3-none-any.whl", hash = "sha256:76190e457d22d768d53b79d4b11be513711c5c8587a4c28a8d605947e5733cde", size = 19905, upload-time = "2024-08-13T12:57:00.572Z" }, +] + +[[package]] +name = "mypy-extensions" +version = "1.1.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/a2/6e/371856a3fb9d31ca8dac321cda606860fa4548858c0cc45d9d1d4ca2628b/mypy_extensions-1.1.0.tar.gz", hash = "sha256:52e68efc3284861e772bbcd66823fde5ae21fd2fdb51c62a211403730b916558", size = 6343, upload-time = "2025-04-22T14:54:24.164Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/79/7b/2c79738432f5c924bef5071f933bcc9efd0473bac3b4aa584a6f7c1c8df8/mypy_extensions-1.1.0-py3-none-any.whl", hash = "sha256:1be4cccdb0f2482337c4743e60421de3a356cd97508abadd57d47403e94f5505", size = 4963, upload-time = "2025-04-22T14:54:22.983Z" }, +] + [[package]] name = "nbclient" version = "0.10.4" @@ -1184,6 +1234,18 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/ec/57/56b9bcc3c9c6a792fcbaf139543cee77261f3651ca9da0c93f5c1221264b/python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427", size = 229892, upload-time = "2024-03-01T18:36:18.57Z" }, ] +[[package]] +name = "python-slugify" +version = "8.0.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "text-unidecode" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/87/c7/5e1547c44e31da50a460df93af11a535ace568ef89d7a811069ead340c4a/python-slugify-8.0.4.tar.gz", hash = "sha256:59202371d1d05b54a9e7720c5e038f928f45daaffe41dd10822f3907b937c856", size = 10921, upload-time = "2024-02-08T18:32:45.488Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a4/62/02da182e544a51a5c3ccf4b03ab79df279f9c60c5e82d5e8bec7ca26ac11/python_slugify-8.0.4-py2.py3-none-any.whl", hash = "sha256:276540b79961052b66b7d116620b36518847f52d5fd9e3a70164fc8c50faa6b8", size = 10051, upload-time = "2024-02-08T18:32:43.911Z" }, +] + [[package]] name = "pyyaml" version = "6.0.3" @@ -1574,6 +1636,15 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/80/72/6949a512f16653cecebb737b8512ee76ca078d8e0e4e948d7322b528fb4d/termynal-0.13.1-py3-none-any.whl", hash = "sha256:7a1605a4d4ed38bf851bf25f842aafa52ef29786d52762aecee59622ed030592", size = 10628, upload-time = "2025-09-01T13:03:34.236Z" }, ] +[[package]] +name = "text-unidecode" +version = "1.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ab/e2/e9a00f0ccb71718418230718b3d900e71a5d16e701a3dae079a21e9cd8f8/text-unidecode-1.3.tar.gz", hash = "sha256:bad6603bb14d279193107714b288be206cac565dfa49aa5b105294dd5c4aab93", size = 76885, upload-time = "2019-08-30T21:36:45.405Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a6/a5/c0b6468d3824fe3fde30dbb5e1f687b291608f9473681bbf7dabbf5a87d7/text_unidecode-1.3-py2.py3-none-any.whl", hash = "sha256:1311f10e8b895935241623731c2ba64f4c455287888b18189350b67134a822e8", size = 78154, upload-time = "2019-08-30T21:37:03.543Z" }, +] + [[package]] name = "tinycss2" version = "1.4.0" @@ -1675,6 +1746,19 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/18/67/36e9267722cc04a6b9f15c7f3441c2363321a3ea07da7ae0c0707beb2a9c/typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548", size = 44614, upload-time = "2025-08-25T13:49:24.86Z" }, ] +[[package]] +name = "typing-inspect" +version = "0.8.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mypy-extensions" }, + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/72/23/bed3ea644bcd77ffe9a7f591eb058c00739747e33ab94d80cc4319ddee8e/typing_inspect-0.8.0.tar.gz", hash = "sha256:8b1ff0c400943b6145df8119c41c244ca8207f1f10c9c057aeed1560e4806e3d", size = 13550, upload-time = "2022-08-17T14:00:05.915Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/be/01/59b743dca816c4b6ca891b9e0f84d20513cd61bdbbaa8615de8f5aab68c1/typing_inspect-0.8.0-py3-none-any.whl", hash = "sha256:5fbf9c1e65d4fa01e701fe12a5bca6c6e08a4ffd5bc60bfac028253a447c5188", size = 8710, upload-time = "2022-08-17T14:00:03.093Z" }, +] + [[package]] name = "urllib3" version = "2.6.3"