diff --git a/MANIFEST.in b/MANIFEST.in index 1d363d33b..bafbd2a51 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,6 @@ # MANIFEST.in exclude .gitignore -include README.rst +include README.md include setup.cfg include CITATIONS.rst include LICENSE diff --git a/README.rst b/README.md similarity index 97% rename from README.rst rename to README.md index 89b1e8049..6359b9198 100644 --- a/README.rst +++ b/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 diff --git a/autoarray/config/README.md b/autoarray/config/README.md new file mode 100644 index 000000000..4b8202c77 --- /dev/null +++ b/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. diff --git a/autoarray/config/README.rst b/autoarray/config/README.rst deleted file mode 100644 index c6dd5c196..000000000 --- a/autoarray/config/README.rst +++ /dev/null @@ -1,16 +0,0 @@ -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. - diff --git a/autoarray/config/visualize/README.md b/autoarray/config/visualize/README.md new file mode 100644 index 000000000..c99ad0275 --- /dev/null +++ b/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. diff --git a/autoarray/config/visualize/README.rst b/autoarray/config/visualize/README.rst deleted file mode 100644 index 1fa4f11d3..000000000 --- a/autoarray/config/visualize/README.rst +++ /dev/null @@ -1,11 +0,0 @@ -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. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 5115a948f..451bedaec 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,2 @@ -```{eval-rst} -.. include:: ../README.rst +```{include} ../README.md ``` diff --git a/pyproject.toml b/pyproject.toml index f95871b0f..19cf2a441 100644 --- a/pyproject.toml +++ b/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 = [