From e09961cbc02b4021e16e7e9b2d2a5f44fe6328d1 Mon Sep 17 00:00:00 2001
From: pehan <pehan@dfds.com>
Date: Mon, 25 Sep 2023 13:57:42 +0100
Subject: [PATCH] add README.md to docs

---
 docs/source/README_link.md |  5 +++++
 docs/source/conf.py        | 17 ++++++++---------
 docs/source/index.rst      |  9 +++++++++
 pyproject.toml             |  1 +
 4 files changed, 23 insertions(+), 9 deletions(-)
 create mode 100644 docs/source/README_link.md

diff --git a/docs/source/README_link.md b/docs/source/README_link.md
new file mode 100644
index 0000000..17e153b
--- /dev/null
+++ b/docs/source/README_link.md
@@ -0,0 +1,5 @@
+<!-- markdownlint-disable -->
+
+```{include} ../../README.md
+
+```
\ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 1e5cfbb..c0ae8a4 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -6,23 +6,22 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'HistoryAIToolKit'
-copyright = '2023, Audrey Roy Greenfeld'
-author = 'Audrey Roy Greenfeld'
-release = '0.0.1'
+project = "HistoryAIToolKit"
+copyright = "2023, Audrey Roy Greenfeld"
+author = "Audrey Roy Greenfeld"
+release = "0.0.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = ["myst_parser"]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_theme = "alabaster"
+html_static_path = ["_static"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
index fe7c0b4..d68bc6c 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -17,3 +17,12 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   README_link
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index 475023c..38cabd7 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -15,6 +15,7 @@ pydantic = "^2.3.0"
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.2"
 sphinx = "^7.2.6"
+myst-parser = "^2.0.0"
 
 [build-system]
 requires = ["poetry-core"]