Skip to content
Snippets Groups Projects
Commit 576e9ff6 authored by Daniel Hornung's avatar Daniel Hornung
Browse files

WIP: Extended documentation.

parent 8116b29c
No related branches found
No related tags found
1 merge request!33Release 0.1
Pipeline #14181 passed
Pipeline: caosdb-cppinttest

#14188

    This commit is part of merge request !33. Comments created here will be created in the context of that merge request.
    ...@@ -143,12 +143,8 @@ trigger_inttest: ...@@ -143,12 +143,8 @@ trigger_inttest:
    tags: [ cached-dind ] tags: [ cached-dind ]
    stage: deploy stage: deploy
    script: script:
    - mkdir -p build - make doc
    - cd build - cp -r build/doc/sphinx_out ../public
    - conan install .. -s "compiler.libcxx=libstdc++11"
    - cmake ..
    - cmake --build . --target doc-sphinx
    - cp -r doc/sphinx_out ../public
    test_pages: test_pages:
    <<: *pages_prepare <<: *pages_prepare
    ......
    ...@@ -64,3 +64,9 @@ conan-create: ...@@ -64,3 +64,9 @@ conan-create:
    conan: conan-install conan-create conan: conan-install conan-create
    .PHONY: conan .PHONY: conan
    doc:
    mkdir -p build && cd build && conan install .. -s $(CONAN_SETTINGS) \
    && cmake .. && cmake --build . --target doc-sphinx \
    && echo "The documentation starts at build/doc/sphinx_out/index.html ."
    .PHONY: doc
    ...@@ -18,6 +18,7 @@ ...@@ -18,6 +18,7 @@
    # along with this program. If not, see <https://www.gnu.org/licenses/>. # along with this program. If not, see <https://www.gnu.org/licenses/>.
    # #
    cmake_minimum_required(VERSION 3.13)
    find_package(Doxygen) find_package(Doxygen)
    if (DOXYGEN_FOUND) if (DOXYGEN_FOUND)
    ...@@ -89,12 +90,11 @@ if (DOXYGEN_FOUND) ...@@ -89,12 +90,11 @@ if (DOXYGEN_FOUND)
    VERBATIM VERBATIM
    ) )
    # Copying files is necessary: https://stackoverflow.com/a/45808534/232888 # Copying files is necessary: https://stackoverflow.com/a/45808534/232888
    # TODO fix for docs FILE(COPY
    #FILE(COPY Examples.rst
    #Examples.rst README_SETUP.md
    #README_SETUP.md
    # Tutorial.rst # Tutorial.rst
    #DESTINATION "${CMAKE_CURRENT_BINARY_DIR}") DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
    else () else ()
    message("Sphinx need to be installed to generate the sphinx documentation") message("Sphinx need to be installed to generate the sphinx documentation")
    endif () endif ()
    ......
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Please register or to comment