From d07e704d53d7cc28e1df5a55689613d753b47912 Mon Sep 17 00:00:00 2001
From: Daniel Hornung <d.hornung@indiscale.com>
Date: Mon, 21 Feb 2022 16:05:51 +0100
Subject: [PATCH] DOC: Simpler documentation how to install libcaosdb.
---
Makefile | 2 +-
README_SETUP.md | 2 +-
doc/Development.rst | 11 ++++++++++-
src/configure | 7 ++++++-
4 files changed, 18 insertions(+), 4 deletions(-)
diff --git a/Makefile b/Makefile
index 0240614..7762119 100644
--- a/Makefile
+++ b/Makefile
@@ -40,9 +40,9 @@ else
TAR_OPTS := --exclude-from=.gitignore -s '/^\./caosdb/'
endif
-.PHONY: doc
doc:
$(MAKE) -C doc html
+.PHONY: doc
###############################################################################
# Styling #
diff --git a/README_SETUP.md b/README_SETUP.md
index e17f2a8..3e483c6 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -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
diff --git a/doc/Development.rst b/doc/Development.rst
index 851fd1d..3c8ff33 100644
--- a/doc/Development.rst
+++ b/doc/Development.rst
@@ -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
diff --git a/src/configure b/src/configure
index b62d5a8..d6c2f73 100755
--- a/src/configure
+++ b/src/configure
@@ -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."
--
GitLab