Mkdocs update (#26)

* reworked docs into mkdocs

* added deploy stuff

* added new build to tests

* update env

* fixed env

* another env update

* forgot material

* addressed comments and changed themes

.github/workflows/ci_testing.yml

@@ -1,4 +1,4 @@
-name: CMake
+name: Build-And-Test
 
 on: [push, pull_request]
 
@@ -99,42 +99,16 @@ jobs:
             conda info
             conda list
   
-      - name: Create Build Environment
-        # Some projects don't allow in-source building, so create separate build and install
-        # directorie; we'll use them as our working directories for subsequent commands.
-        run: |
-            cmake -E make_directory ${{github.workspace}}/build
-            cmake -E make_directory ${{github.workspace}}/install
-  
-      - name: Configure CMake
-        working-directory: ${{github.workspace}}/build
-        run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DSPICEQL_BUILD_LIB=OFF -DCMAKE_INSTALL_PREFIX=${{github.workspace}}/install
-
       - name: Build
-        working-directory: ${{github.workspace}}/build
+        working-directory: ${{github.workspace}}/
         # Execute the build.
         run: |
-          cmake --build . --config $BUILD_TYPE
+          mkdocs build
   
       - name: Check Build Docs
-        working-directory: ${{github.workspace}}/build/docs/sphinx
+        working-directory: ${{github.workspace}}/site
         # Check for the built docs
         run: |
             test -e index.html
-            test -e reference/api.html
-            test -e reference/tutorials.html
   
-      - name: Install Docs
-        working-directory: ${{github.workspace}}/build
-        # Install the build.
-        run: |
-          cmake --install . --config $BUILD_TYPE
-  
-      - name: Check Install Docs
-        working-directory: ${{github.workspace}}/install
-        # Check for the built docs
-        run: |
-            test -e share/doc/SpiceQL/sphinx/index.html
-            test -e share/doc/SpiceQL/sphinx/reference/api.html
-            test -e share/doc/SpiceQL/sphinx/reference/tutorials.html
 

.github/workflows/deploy.yml

@@ -70,33 +70,21 @@ jobs:
             cmake -E make_directory ${{github.workspace}}/build
             cmake -E make_directory ${{github.workspace}}/install
   
-      - name: Configure CMake
-        working-directory: ${{github.workspace}}/build
-        run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DSPICEQL_BUILD_LIB=OFF -DCMAKE_INSTALL_PREFIX=${{github.workspace}}/install
-
       - name: Build
-        working-directory: ${{github.workspace}}/build
+        working-directory: ${{github.workspace}}
         # Execute the build.
         run: |
-          cmake --build .
+          mkdocs build
   
       - name: Check Build Docs
-        working-directory: ${{github.workspace}}/build/docs/sphinx
+        working-directory: ${{github.workspace}}/site/
         # Check for the built docs
         run: |
             test -e index.html
-            test -e reference/api.html
-            test -e reference/tutorials.html
   
-      - name: Install Docs
-        working-directory: ${{github.workspace}}/build
-        # Install the build.
-        run: |
-          cmake --install .
-     
       - name: Upload to S3
-        working-directory: ${{github.workspace}}/install
+        working-directory: ${{github.workspace}}/
         run: |
           ls -l share/doc/SpiceQL/sphinx/
-          aws s3 sync --delete share/doc/SpiceQL/sphinx/ s3://asc-public-docs/software_manuals/spiceql/
+          aws s3 sync --delete site/ s3://asc-public-docs/software_manuals/spiceql/
           

CMakeLists.txt

@@ -204,14 +204,3 @@ else()
   message(STATUS "Skipping Bindings")
 endif()
 
-##############
-# Docs Build #
-##############
-
-option (SPICEQL_BUILD_DOCS "Build the SpiceQL Docs" ON)
-
-if(SPICEQL_BUILD_DOCS)
-  add_subdirectory ("docs")
-else()
-  message(STATUS "Skipping Docs")
-endif()

bindings/python/pyspiceql.i

@@ -1,5 +1,7 @@
 %module pyspiceql
 
+%feature("autodoc", "3");
+
 %include "std_vector.i"
 %include "std_string.i"
 %include "std_array.i"