docs: convert remaining prose .rst to MyST .md (pass 2)

MANIFEST.in

@@ -1,6 +1,6 @@
 # MANIFEST.in
 exclude .gitignore
-include README.rst
+include README.md
 include setup.cfg
 include CITATIONS.rst
 include LICENSE

README.rst → README.md

@@ -1,2 +1,3 @@
-# PyAutoArray
-A library for manipulating arrays within the PyAuto software framework
+# PyAutoArray
+
+A library for manipulating arrays within the PyAuto software framework

autoarray/config/README.md

@@ -0,0 +1,13 @@
+The `config` folder contains configuration files which customize default **PyAutoLens**.
+
+# Folders
+
+- `priors`: Configs defining default priors assumed on every model component and set of parameters.
+- `visualize`: Configs defining what images are output by a lens model fit.
+
+# Files
+
+- `general.yaml`: Customizes general **PyAutoLens** settings.
+- `grids.yaml`: Customize default behaviour of grids when used for calculations.
+- `logging.yaml`: Customizes the logging behaviour.
+- `notation.yaml`: Configs defining labels and formatting of model parameters when used for visualization.

autoarray/config/visualize/README.md

@@ -0,0 +1,10 @@
+The `config` folder contains configuration files which customize default **PyAutoLens**.
+
+# Files
+
+- `general.yaml`: Customizes general visualization settings (e.g. the matplotlib backend).
+- `include.yaml`: Customize features that appears on plotted images by default (e.g. a mask, a grid).
+- `plots.yaml`: Customize which figures are output during a model-fit.
+- `mat_wrap.yaml`: Specify the default matplotlib settings when figures and subplots are plotted.
+- `mat_wrap_1d.yaml`: Specify the default matplotlib settings when 1D figures and subplots are plotted.
+- `mat_wrap_2d.yaml`: Specify the default matplotlib settings when 2D figures and subplots are plotted.

docs/index.md

@@ -1,3 +1,2 @@
-```{eval-rst}
-.. include:: ../README.rst
+```{include} ../README.md
 ```

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "autoarray"
 dynamic = ["version"]
   description="PyAuto Data Structures"
-readme = { file = "README.rst", content-type = "text/x-rst" }
+readme = { file = "README.md", content-type = "text/markdown" }
 license = { text = "MIT" }
 requires-python = ">=3.9"
 authors = [