Issue #17: Autogeneration of docs

.github/workflows/documentation.yml

@@ -0,0 +1,42 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - develop
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+    contents: write
+    pages: write
+    id-token: write
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+            python-version: '3.10'     
+      - name: Mock Basilisk
+        run: |
+          cp docs/sitecustomize.py $(python -c 'import site; print(site.getsitepackages()[0])')/sitecustomize.py
+      - name: Install dependencies
+        run: |
+          pip install -e .
+        # skip finish install steps
+      - name: Sphinx build
+        run: |
+          cd docs
+          make html
+          cd ..
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html
+          force_orphan: true
+
+

docs/source/index.rst

@@ -15,6 +15,8 @@ BSK-RL: Environments and Algorithms for Spacecraft Planning and Scheduling
 .. note::
 
     BSK-RL and its documentation are under active development. Please continue to check back for updates. 
+
+.. note::
 
     New environments should be built using the :ref:`general satellite tasking framework <bsk_rl.envs.general_satellite_tasking>`; legacy environments are in the process of being ported to this framework.
 

docs/source/install.rst

@@ -45,6 +45,4 @@ Instructions
 Common Issues
 -------------
 
-.. note::
-
-    See `#51 <https://github.com/AVSLab/bsk_rl/issues/51>`_ for issues with `chebpy` installation on Silicon Macs during or after ``finish_install``.
+Please report new installation issues on GitHub.