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

DOC: Simpler documentation how to install libcaosdb.

parent 32a00ef7
Branches
Tags
No related merge requests found
Pipeline #19630 passed
Pipeline: caosdb-octaveinttest

#19631

    ......@@ -40,9 +40,9 @@ else
    TAR_OPTS := --exclude-from=.gitignore -s '/^\./caosdb/'
    endif
    .PHONY: doc
    doc:
    $(MAKE) -C doc html
    .PHONY: doc
    ###############################################################################
    # Styling #
    ......
    ......@@ -5,7 +5,7 @@
    This package requires the following software:
    - conan: `pip install conan`
    - Create a local *libcaosdb* conan package: See
    - libcaosdb: Download the [libcaosdb sources](https://gitlab.com/caosdb/caosdb-cpplib) and run `make conan`. See
    https://gitlab.indiscale.com/caosdb/src/caosdb-cpplib for further instructions.
    - For running this library, a valid libcaosdb configuration is needed, for example a
    `.caosdb_client.json` file in your home directory or current working directory. Please look at
    ......
    ......@@ -35,8 +35,17 @@ Writing Documentation
    Requirements
    ------------
    - For tests, we use MOxUnit, which can be installed like this:
    - We use a dedicated Octave package for documentation generation: ` ``generate_html`` <https://keepachangelog.org>`_. This package
    .. code-block:: console
    wget --output-document MOxUnit-master.zip https://github.com/MOxUnit/MOxUnit/archive/master.zip
    unzip MOxUnit-master.zip
    cd MOxUnit-master
    make install
    cd ..
    - We use a dedicated Octave package for documentation generation: generate_html_. This package
    can be installed as follows:
    .. code-block:: octave
    ......
    ......@@ -16,7 +16,12 @@ function error {
    #
    # This function should be called at such a place that the conanfile is in the parent directory.
    function check_deps {
    general_help="Please check the online documentation and installation instructions
    general_help="This package requires the following software:
    - conan: Install with 'pip install conan'.
    - libcaosdb: Download the libcaosdb sources from
    https://gitlab.com/caosdb/caosdb-cpplib and run 'make conan'.
    Please check the online documentation and installation instructions
    at https://docs.indiscale.com/caosdb-octavelib and
    https://gitlab.com/caosdb/caosdb-octavelib for more information and
    contact options."
    ......
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Please register or to comment