Skip to content

Commit 6988085

Browse files
Jammy2211claude
authored andcommitted
docs: convert remaining prose .rst to MyST .md (pass 2)
Continues the rst→md migration started in PyAutoFit#1245. Converts the root README and the two `autoarray/config/.../README.rst` files to MyST. Also: - pyproject.toml: switches readme content-type to text/markdown - MANIFEST.in: ships README.md in the sdist - docs/index.md: replaces the eval-rst include of README.rst with the MyST-native `{include}` directive on README.md Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent ff21eb6 commit 6988085

8 files changed

Lines changed: 29 additions & 33 deletions

File tree

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MANIFEST.in
22
exclude .gitignore
3-
include README.rst
3+
include README.md
44
include setup.cfg
55
include CITATIONS.rst
66
include LICENSE
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
# PyAutoArray
2-
A library for manipulating arrays within the PyAuto software framework
1+
# PyAutoArray
2+
3+
A library for manipulating arrays within the PyAuto software framework

autoarray/config/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
The `config` folder contains configuration files which customize default **PyAutoLens**.
2+
3+
# Folders
4+
5+
- `priors`: Configs defining default priors assumed on every model component and set of parameters.
6+
- `visualize`: Configs defining what images are output by a lens model fit.
7+
8+
# Files
9+
10+
- `general.yaml`: Customizes general **PyAutoLens** settings.
11+
- `grids.yaml`: Customize default behaviour of grids when used for calculations.
12+
- `logging.yaml`: Customizes the logging behaviour.
13+
- `notation.yaml`: Configs defining labels and formatting of model parameters when used for visualization.

autoarray/config/README.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
The `config` folder contains configuration files which customize default **PyAutoLens**.
2+
3+
# Files
4+
5+
- `general.yaml`: Customizes general visualization settings (e.g. the matplotlib backend).
6+
- `include.yaml`: Customize features that appears on plotted images by default (e.g. a mask, a grid).
7+
- `plots.yaml`: Customize which figures are output during a model-fit.
8+
- `mat_wrap.yaml`: Specify the default matplotlib settings when figures and subplots are plotted.
9+
- `mat_wrap_1d.yaml`: Specify the default matplotlib settings when 1D figures and subplots are plotted.
10+
- `mat_wrap_2d.yaml`: Specify the default matplotlib settings when 2D figures and subplots are plotted.

autoarray/config/visualize/README.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
```{eval-rst}
2-
.. include:: ../README.rst
1+
```{include} ../README.md
32
```

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
66
name = "autoarray"
77
dynamic = ["version"]
88
description="PyAuto Data Structures"
9-
readme = { file = "README.rst", content-type = "text/x-rst" }
9+
readme = { file = "README.md", content-type = "text/markdown" }
1010
license = { text = "MIT" }
1111
requires-python = ">=3.9"
1212
authors = [

0 commit comments

Comments
 (0)