Merge pull request #62 from Athanaseus/update_docs

Update docs

.github/workflows/publish_package.yml

@@ -18,15 +18,15 @@ jobs:
        github.event.ref == 'refs/heads/master')
     steps:
       - name: Set up Python 3
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v3
         with:
           python-version: '3.x'
 
       - name: Install latest setuptools, wheel, pip
         run: python3 -m pip install -U pip setuptools wheel
 
       - name: Checkout source
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 1
 

.github/workflows/test_installation.yml

@@ -11,14 +11,14 @@ on:
 
 jobs:
   build:
-
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
+        os: [ ubuntu-20.04, ubuntu-22.04 ]
         python-version: [3.8, 3.9]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v1
       with:

.readthedocs.yaml

@@ -1,29 +1,31 @@
-# .readthedocs.yaml
+# .readthedocs.yml
 # 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:
-  os: ubuntu-20.04
-  tools:
-    python: "3.8"
-    # You can also specify other tool versions:
-    # nodejs: "16"
-    # rust: "1.55"
-    # golang: "1.17"
-
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: doc/conf.py
+  configuration: doc/conf.py
 
-# If using Sphinx, optionally build your docs in additional formats such as PDF
-formats:
-   - pdf
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
 
-# Optionally declare the Python requirements required to build your docs
+# Optionally set the version of Python and requirements required to build your docs
 python:
-   install:
-   - requirements: requirements.txt
+  install:
+    - method: pip
+      path: .
+      extra_requirements: 
+        - doc
+    - method: pip
+      path: .
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.8"
+  jobs:
+    pre_build:
+      - echo "Running pre-build commands."

README.rst

@@ -1,15 +1,16 @@
 =======
 aimfast
 =======
+
+|Build Version|
 |Doc Status|
 |Pypi Version|
-|Build Version|
 |Python Versions|
 |Project License|
 
 An Astronomical Image Fidelity Assessment Tool
 
-Main website: https://aimfast.readthedocs.io
+Main website: aimfast.rtfd.io_
 
 ==============
 Introduction
@@ -53,8 +54,8 @@ standards pep8_.
 .. |Pypi Version| image:: https://img.shields.io/pypi/v/aimfast.svg
                   :target: https://pypi.python.org/pypi/aimfast
                   :alt:
-.. |Build Version| image:: https://travis-ci.org/Athanaseus/aimfast.svg?branch=master
-                  :target: https://travis-ci.org/Athanaseus/aimfast
+.. |Build Version| image:: https://github.com/Athanaseus/aimfast/actions/workflows/test_installation.yml/badge.svg
+                  :target: https://github.com/Athanaseus/aimfast/actions/workflows/test_installation.yml/
                   :alt:
 
 .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/aimfast.svg
@@ -65,6 +66,7 @@ standards pep8_.
                      :target: https://github.com/Athanaseus/aimfast/blob/master/LICENSE
                      :alt:
 
+.. _aimfast.rtfd.io: https://aimfast.rtfd.io
 .. _source: https://github.com/Athanaseus/aimfast
 .. _license: https://github.com/Athanaseus/aimfast/blob/master/LICENSE
 .. _pep8: https://www.python.org/dev/peps/pep-0008

doc/conf.py

@@ -74,9 +74,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.3.0'
+version = '1.3.2'
 # The full version, including alpha/beta/rc tags.
-release = '1.3.0'
+release = '1.3.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -108,7 +108,8 @@
 #show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+#pygments_style = 'sphinx'
+pygments_style = "default"
 
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
@@ -121,7 +122,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'agogo'
+html_theme = "furo"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

doc/requirements.readthedocs.txt

@@ -0,0 +1,8 @@
+numpydoc
+myst-parser
+sphinx-copybutton
+sphinx-design
+sphinx-inline-tabs
+sphinx-tabs
+sphinx
+furo