Merge pull request #565 from BradleySappington/release_docs

1.1.1 Release docs

README.rst

@@ -2,7 +2,7 @@
 POPPY: Physical Optics Propagation in Python
 ============================================
 
-.. image:: docs/figures/readme_fig.png
+.. image:: https://github.com/spacetelescope/poppy/blob/develop/docs/figures/readme_fig.png?raw=true
 
 .. image:: https://img.shields.io/pypi/v/poppy.svg
    :target: https://pypi.python.org/pypi/poppy
@@ -35,6 +35,6 @@ Projects using POPPY
 
 POPPY provides the optical modeling framework used in:
 
-* WebbPSF, a PSF simulator for NASA's JWST and WFIRST space telescopes. See https://pypi.python.org/pypi/webbpsf
-* ``gpipsfs``, a PSF simulator for the Gemini Planet Imager coronagraph. See https://github.com/geminiplanetimager/gpipsfs 
+* WebbPSF, a PSF simulator for NASA's JWST and Roman space telescopes. See https://pypi.python.org/pypi/webbpsf
+* ``gpipsfs``, a PSF simulator for the Gemini Planet Imager coronagraph. See https://github.com/geminiplanetimager/gpipsfs
 

docs/relnotes.rst

@@ -5,6 +5,17 @@ Release Notes
 
 For a list of contributors, see :ref:`about`.
 
+
+1.1.1
+-----
+
+.. _rel1.1.1:
+
+*2023 May 16*
+
+This is a very minor re-release, to fix some documentation formatting and release packaging issues with the 1.1.0 release. No changes in functionality.
+
+
 1.1.0
 -----
 

pyproject.toml

@@ -16,7 +16,7 @@ dependencies = [
     "astropy>=4.3.0",
 ]
 dynamic = ["version"]
-readme = "README.md"
+readme = "README.rst"
 
 [project.optional-dependencies]
 all = ["synphot"]

readthedocs.yml

@@ -1,16 +1,27 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
 version: 2
 
+# Set the version of Python and other tools you might need
+build:
+  tools:
+    python: "3.9"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
-python:
-    version: 3.9
-    install:
-        - method: pip
-          path: .
-          extra_requirements:
-             - docs
-
+# If using Sphinx, optionally build your docs in additional formats such as PDF
 formats:
-    - pdf
+  - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs