Docs

.github/workflows/sphinx.yml

@@ -9,8 +9,15 @@ jobs:
       contents: write
     steps:
     - uses: actions/checkout@v4
-    - name: Build HTML
-      uses: ammaraskar/sphinx-action@master
+    - name: Set Python Version
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10' 
+    - name: Install requirements
+      run: pip install -r env_files/all_requirements.txt
+    - run: ls .
+    - name: Make HTML
+      run: make -C docs/ html
     - name: Upload artifacts
       uses: actions/upload-artifact@v4
       with:

README.md

@@ -2,6 +2,8 @@
 
 Contains the intelligent systems module and sensor logic for the SJSU Robotics' 3-Wheeled Mars Rover
 
+## [Documentation Site](https://sjsuroboticsteam.github.io/urc-intelligent-systems-2023/index.html)
+
 ## Setup
 
 To get started, you will need to install the following dependencies, you can do this by using a virtual environment and the requirements.txt file in the root directory of the project.

docs/README.md

@@ -0,0 +1,21 @@
+# Using Sphinx to build Doc site
+
+If you create a new python file, that file will need to be included in the
+documentation by running this command
+
+~~~~~~~~~~~~~~~~~~~~~~~~~bash
+sphinx-apidoc -o docs/ . # from project root
+# or
+sphinx-apidoc -o . ..    # from docs dir
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Following this or if you only modified a python file instead of created a new
+one, then you can locally build the doc site using the following command
+
+~~~~~~~~~~~~~~~~~~~bash
+make -C docs/ html # from project root
+# or
+make html          # from docs dir
+~~~~~~~~~~~~~~~~~~~
+
+this will build the Doc site in `docs/_build/html`.

docs/index.rst

@@ -7,6 +7,7 @@ Welcome to Autonomy@SJSU-Robotics's documentation!
 ==================================================
 
 Hi Welcome to documentation
+Hello There
 
 .. toctree::
    :maxdepth: 10

docs/modules.rst

@@ -1,5 +1,5 @@
-autonomy_setup_test
-===================
+urc-intelligent-systems-2023
+============================
 
 .. toctree::
    :maxdepth: 4