Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 880 Bytes

File metadata and controls

28 lines (18 loc) · 880 Bytes

MedCAT Tutorials (version 2)

The MedCAT Tutorials provide an interactive learning path for using MedCAT.

See the cogstack documentation site to view these tutorials and all the documentation on docs.cogstack.org

Developer Readme

The following readmes are around the setup of the tutorials themselves aimed at a tutorial author.

Documentation Build

The medcat-v2 documentation site imports this project’s MkDocs navigation file directly. The relevant plugins are the mkdocs-monorepo-plugin and the mkdocs-jupyter plugin.

In medcat-v2/mkdocs.yml the Tutorials section is wired in via an include:

nav:
  - Tutorials: '!include ../medcat-v2-tutorials/mkdocs.yml'

Run the docs locally (rendered site)

To preview the rendered docs site locally:

cd cogstack-nlp/medcat-v2-tutorials
uv run mkdocs serve