fix(docs): include readme in docs

Author: Diaoul

docs/conf.py

@@ -27,7 +27,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.coverage"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.coverage", "myst_parser"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/index.rst

@@ -1,33 +1,5 @@
-.. enzyme documentation master file, created by
-   sphinx-quickstart on Fri May 10 01:11:03 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Enzyme
-======
-Release v\ |version|
-
-Enzyme is a Python module to parse video metadata.
-
-
-Usage
------
-Parse a MKV file::
-
-    >>> with open('How.I.Met.Your.Mother.S08E21.720p.HDTV.X264-DIMENSION.mkv', 'rb') as f:
-    ...    mkv = enzyme.MKV(f)
-    ... 
-    >>> mkv.info
-    <Info [title=None, duration=0:20:56.005000, date=2013-04-15 14:06:50]>
-    >>> mkv.video_tracks
-    [<VideoTrack [1, 1280x720, V_MPEG4/ISO/AVC, name=None, language=eng]>]
-    >>> mkv.audio_tracks
-    [<AudioTrack [2, 6 channel(s), 48000Hz, A_AC3, name=None, language=und]>]
-
-
-License
--------
-Apache2
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
 
 
 API Documentation

pyproject.toml

@@ -34,7 +34,7 @@ dependencies = ["importlib_resources>=4.6; python_version=='3.8'"]
 # extras
 # https://peps.python.org/pep-0621/#dependencies-optional-dependencies
 [project.optional-dependencies]
-docs = ["sphinx", "sphinx-rtd-theme"]
+docs = ["sphinx", "sphinx-rtd-theme", "myst-parser"]
 test = [
   "PyYAML",
   "requests",