docs: include readme as main page in the docs

adfinis · Dec 19, 2024 · 70e076a · 70e076a
1 parent f705541
commit 70e076a
Show file tree

Hide file tree

Showing 4 changed files with 100 additions and 63 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -15,9 +15,14 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'myst_parser', # No need to add all click files manually to TO
+    'myst_parser',
     'sphinx.ext.autosectionlabel',
-    'sphinx.ext.autodoc'
+    'sphinx.ext.autodoc',
+]
+myst_enable_extensions = [
+    "linkify",
+    "replacements",
+    "smartquotes",
 ]
 
 # For autodoc

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,13 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Pyaptly documentation
-=====================
-
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
-
+.. include:: README.md
+   :parser: myst_parser.sphinx_
 
 .. toctree::
    :maxdepth: 3

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -58,6 +58,7 @@ python-lsp-ruff = "^2.2.0"
 sphinx = "^8.1.3"
 myst-parser = "^4.0.0"
 sphinx-rtd-theme = "^3.0.1"
+linkify-it-py = "^2.0.3"
 
 [tool.coverage.run]
 omit = ["pyaptly/tomli_w/_writer.py"]