Build docs with myst instead of rst (#5)

* Build docs with myst instead of rst

* Add markdown support to the extension

* Fix file extension check

* Update docs to advertise md support

Author: jacobtomlinson

README.md

@@ -8,6 +8,7 @@ Features:
 
 - Render documentation from your `Chart.yaml` and `values.yaml` files.
 - Sphinx extension for including in Python documentation.
+- Works with `rst` and `md` documentation source files.
 
 ## Installation
 

docs/conf.py

@@ -26,7 +26,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_helm.ext", "sphinx_click.ext"]
+extensions = ["sphinx_helm.ext", "sphinx_click.ext", "myst_parser"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/customizing.md

@@ -0,0 +1,3 @@
+# Customizing your docs
+
+TODO

docs/customizing.rst

@@ -0,0 +1,58 @@
+# Sphinx-helm
+
+```{toctree}
+:maxdepth: 2
+:hidden: true
+customizing
+```
+
+`sphinx-helm` is a [Sphinx](https://www.sphinx-doc.org/) plugin for automatically generating documentation for your [Helm charts](https://helm.sh/).
+
+It will use the chart's `Chart.yaml` and `values.yaml` files in order to
+generate the content in a markup language of your choice.
+
+## Features
+
+- Render documentation from your `Chart.yaml` and `values.yaml` files.
+- Sphinx extension for including in Python documentation.
+- Works with `rst` and `md` documentation source files.
+
+## Installation
+
+```console
+$ pip install sphinx-helm
+```
+
+## Example
+
+Create an example `hello-world` Helm chart with `helm create`.
+
+```console
+$ helm create hello-world
+Creating hello-world
+```
+
+- Enable the plugin in your Sphinx ``conf.py`` file:
+
+```python
+extensions = ['sphinx-helm.ext']
+```
+
+- Now you can use the `helm` directive wherever you wish in your documentation.
+
+```rst
+.. helm:: path/to/hello-world
+```
+
+```{note}
+sphinx-helm paths are relative to the root of your documentation.
+```
+   
+## Example
+
+*The following was autogenerated from the simple nginx example chart in sphinx-helm's test suite.*
+
+
+```{helm} ../sphinx_helm/tests/mockcharts/simple
+
+```

docs/index.md

@@ -19,6 +19,7 @@ test = [
 docs = [
     "sphinx",
     "sphinx-click",
+    "myst-parser>=3.0.1",
 ]
 
 [build-system]

docs/index.rst

@@ -22,7 +22,11 @@ def run(self):
             self.arguments[0],
         )
         if self.options.get('output_format') is None:
-            self.options.update({'output_format': 'rst'})
+            # if page is being built with myst use markdown
+            if self.state.document.current_source.endswith('.md'):
+                self.options.update({'output_format': 'markdown'})
+            else:
+                self.options.update({'output_format': 'rst'})
         output = ViewList(gen(chart_path, output_format=self.options.get('output_format')).split("\n"))
 
         node = nodes.section()