docs: Setup readthedocs for medcat (#6)

* Setup readthedocs for medcat

* docs: Add MedCAT logo for docs. Update links

Author: alhendrickson

README.md

@@ -1,12 +1,14 @@
 # Cogstack NLP
 
-[![Build Status](https://github.com/CogStack/cogstack-nlp/actions/workflows/medcat-v2-main.yml/badge.svg?branch=main)](https://github.com/CogStack/MedCAT2/actions/workflows/main.yml?query=branch%3main)
-[![Documentation Status](https://readthedocs.org/projects/medcat2/badge/?version=latest)](https://medcat2.readthedocs.io/en/latest/?badge=latest)
+[![Build Status](https://github.com/CogStack/cogstack-nlp/actions/workflows/medcat-v2_main.yml/badge.svg?branch=main)](https://github.com/CogStack/cogstack-nlp/actions/workflows/medcat-v2_main.yml/badge.svg?branch=main)
+[![Documentation Status](https://readthedocs.org/projects/cogstack-nlp/badge/?version=latest)](https://readthedocs.org/projects/cogstack-nlp/badge/?version=latest)
 [![Latest release](https://img.shields.io/github/v/release/CogStack/MedCAT2)](https://github.com/CogStack/MedCAT2/releases/latest)
+<!-- [![pypi Version](https://img.shields.io/pypi/v/medcat.svg?style=flat-square&logo=pypi&logoColor=white)](https://pypi.org/project/medcat/) -->
 
 Cogstack Natural Language Processing is for analysing clinical data using AI to draw insights from text in or documents in an Electronic Health Records.
 
 
 **Official Docs [here](https://medcat2.readthedocs.io/en/latest/)**
+
 **Discussion Forum [discourse](https://discourse.cogstack.org/)**
 

medcat-v2/.readthedocs.yaml

@@ -10,10 +10,10 @@ build:
     python: "3.10"
 
 sphinx:
-  configuration: docs/conf.py
+  configuration: medcat-v2/docs/conf.py
 
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: medcat-v2/docs/requirements.txt
     - method: pip
-      path: .
+      path: medcat-v2/

medcat-v2/README.md

@@ -1,10 +1,10 @@
-# Medical  <img src="https://raw.githubusercontent.com/CogStack/MedCAT/main/media/cat-logo.png" width=45> oncept Annotation Tool (version 2)
+# Medical  <img src="https://github.com/CogStack/cogstack-nlp/blob/main/media/cat-logo.png?raw=true" width=45> oncept Annotation Tool (version 2)
 
 **There's a number of breaking changes in MedCAT v2 compared to v1.**
 Details are outlined [here](docs/breaking_changes.md).
 
-[![Build Status](https://github.com/CogStack/MedCAT2/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/CogStack/MedCAT2/actions/workflows/main.yml?query=branch%3main)
-[![Documentation Status](https://readthedocs.org/projects/medcat2/badge/?version=latest)](https://medcat2.readthedocs.io/en/latest/?badge=latest)
+[![Build Status](https://github.com/CogStack/cogstack-nlp/actions/workflows/medcat-v2_main.yml/badge.svg?branch=main)](https://github.com/CogStack/cogstack-nlp/actions/workflows/medcat-v2_main.yml/badge.svg?branch=main)
+[![Documentation Status](https://readthedocs.org/projects/cogstack-nlp/badge/?version=latest)](https://readthedocs.org/projects/cogstack-nlp/badge/?version=latest)
 [![Latest release](https://img.shields.io/github/v/release/CogStack/MedCAT2)](https://github.com/CogStack/MedCAT2/releases/latest)
 <!-- [![pypi Version](https://img.shields.io/pypi/v/medcat.svg?style=flat-square&logo=pypi&logoColor=white)](https://pypi.org/project/medcat/) -->
 

medcat-v2/docs/conf.py

@@ -75,7 +75,7 @@
     'css/overrides.css'
 ]
 
-html_logo = '../media/cat-logo.svg'
+html_logo = '../../media/cat-logo.svg'
 
 html_theme_options = {
     'display_version': True,

medcat-v2/docs/main.md

@@ -1,4 +1,4 @@
-# Medical  <img src="https://github.com/CogStack/cogstack-nlp/blob/main/medcat-v2/media/cat-logo.png?raw=true" width=45>oncept Annotation Tool (v2)
+# Medical  <img src="https://github.com/CogStack/cogstack-nlp/blob/main/media/cat-logo.png?raw=true" width=45>oncept Annotation Tool (v2)
 
 **There's a number of breaking changes in MedCAT v2 compared to v1.**
 Details are outlined [here](breaking_changes.md).