Unverified Commit 5f5f89cb authored by Kelvin Rodriguez's avatar Kelvin Rodriguez Committed by GitHub
Browse files

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
parent f6495c0c

.github/workflows/ci_testing.yml

+4 −30
Original line number Diff line number Diff line 
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

+5 −17
Original line number Diff line number Diff line
@@ -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

+0 −11
Original line number Diff line number Diff line
@@ -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

+2 −0
Original line number Diff line number Diff line 
%module pyspiceql



%feature("autodoc", "3");



%include "std_vector.i"

%include "std_string.i"

%include "std_array.i"

docs/CMakeLists.txt

deleted100644 → 0
+0 −65
Original line number Diff line number Diff line 
message(STATUS "Setting Up Docs")



find_package(Doxygen REQUIRED)

find_package(Sphinx REQUIRED)



# Find all the public headers

file(GLOB_RECURSE SPICEQL_PUBLIC_HEADERS ${SPICEQL_BUILD_INCLUDE_DIR}/*.h)



set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/SpiceQL/include/)

set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR})

set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)

set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)

set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)



configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)



message(STATUS "DOXYGEN_INPUT_DIR: " ${DOXYGEN_INPUT_DIR})

message(STATUS "DOXYGEN_OUTPUT_DIR: " ${DOXYGEN_OUTPUT_DIR})

message(STATUS "DOXYGEN_INDEX_FILE: " ${DOXYGEN_INDEX_FILE})

message(STATUS "DOXYFILE_IN: " ${DOXYFILE_IN})

message(STATUS "DOXYFILE_OUT: " ${DOXYFILE_OUT})



file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})



add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}

                   DEPENDS ${SPICEQL_PUBLIC_HEADERS}

                   COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT} 

                   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}

                   MAIN_DEPENDENCY Doxyfile

                   COMMENT "Generating docs"

                   VERBATIM)



add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE})



set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR})

set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx)

set(SPHINX_INDEX_FILE ${SPHINX_BUILD}/index.html)



set(SPHINX_RST_FILES ${CMAKE_CURRENT_SOURCE_DIR}/index.rst

                     ${CMAKE_CURRENT_SOURCE_DIR}/reference/api.rst

                     ${CMAKE_CURRENT_SOURCE_DIR}/reference/tutorials.rst)



add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}

                   COMMAND

                     ${SPHINX_EXECUTABLE} -b html

                     # Tell Breathe where to find the Doxygen output

                     -Dbreathe_projects.SpiceQL=${DOXYGEN_OUTPUT_DIR}/xml

                   ${SPHINX_SOURCE} ${SPHINX_BUILD}

                   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

                   DEPENDS ${SPICEQL_PUBLIC_HEADERS}

                   # Other docs files you want to track should go here (or in some variable)

                   ${SPHINX_RST_FILES}

                   ${CMAKE_CURRENT_SOURCE_DIR}/../README.md # Docs insert the readme, so it's a dep

                   ${DOXYGEN_INDEX_FILE}

                   # MAIN_DEPENDENCY ${SPHINX_SOURCE}/conf.py

                   COMMENT "Generating documentation with Sphinx")





# Nice named target so we can run the job easily

add_custom_target(Sphinx ALL DEPENDS ${SPHINX_INDEX_FILE})



# Add an install target to install the docs

include(GNUInstallDirs)

install(DIRECTORY ${SPHINX_BUILD}

DESTINATION ${CMAKE_INSTALL_DOCDIR})