Merge pull request #44 from emolter/ci-fixes

ci checks for issue #43

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v3
@@ -50,3 +50,7 @@ jobs:
         token: ${{ secrets.CODECOV_TOKEN }}
         file: ./coverage.xml
         fail_ci_if_error: true
+    - name: Sphinx build check
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: docs

.readthedocs.yml

@@ -1,15 +1,22 @@
+# .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:
-  image: latest
-
-python:
-  version: 3.7
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
-        - all
-
-formats: []
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#   - requirements: docs/requirements.txt

docs/contributing.rst

@@ -9,7 +9,7 @@ If you are considering making a contribution, please follow the steps below. The
 
  * Open an issue `here <https://github.com/emolter/pylanetary/issues>`_ describing the problem you intend to solve or the new feature you intend to build. We are pretty lax about how issues are presented or formatted, but it still might be useful to look through `the issues quickstart <https://docs.github.com/en/issues/tracking-your-work-with-issues/quickstart>`_. 
 
- * Make a fork the main branch of the repository. See the `contributing quickstart <https://docs.github.com/en/get-started/quickstart/contributing-to-projects>`_ for the recommended workflow and git commands. See the `forking quickstart <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_ for a more detailed tutorial about forking, including setup for synchronizing with the upstream branch.
+ * Fork the main branch of the repository. See the `contributing quickstart <https://docs.github.com/en/get-started/quickstart/contributing-to-projects>`_ for the recommended workflow and git commands. See the `forking quickstart <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_ for a more detailed tutorial about forking, including setup for synchronizing with the upstream branch.
 
  * Make your changes or new development. Please see the New Features section below, and start a conversation in the comments of the issue you submitted if you have questions about how best to implement your changes.