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

DOC: CHANGELOG and documentation generation.

parent fe0f8cdc
No related branches found
No related tags found
1 merge request!3Full functionality of libcaosdb
Pipeline #12994 passed
Pipeline: caosdb-octaveinttest

#12996

    ......@@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
    ### Added ###
    - Full functionality of libcaosdb mapped to Octave / Matlab.
    ## [0.0.1] - 2021-08-12 ##
    ### Added ###
    ......
    ===========
    Development
    ===========
    Structure
    ---------
    =========
    The sources for functions and classes are in ``src/``. Private functions (mostly C++ source files
    which are to be compiled into ``*.mex``) are implemented in ``private/_some_function.*``.
    which are to be compiled into ``*.mex``) are implemented in
    ``private/maox_some_function.*``. (``maox`` stands for "mex file for CaosDB".
    Writing Documentation
    ---------------------
    =====================
    - Example for texinfo documentation:
    https://github.com/gnu-octave/octave/blob/default/scripts/geometry/inpolygon.m
    - The first string after the copyright block is used for documentation. This implies that the
    copyright block must be recognized as such: A copyright line should be the first line there.
    - Documentation should be written as TexInfo (see below for details) in order to be available in the
    online documentation.
    - Extract documentation from file:
    ``[txt, form] = get_help_text_from_file(make_absolute_filename('pkg/inst/some_function.m'))``
    - Generate HTML documentation from single file:
    ......@@ -29,3 +31,15 @@ Writing Documentation
    .. code-block:: octave
    generate_package_html('caosdb', 'htdocs', 'octave-forge')
    TexInfo details
    ---------------
    Here is an Example for texinfo documentation:..
    https://github.com/gnu-octave/octave/blob/default/scripts/geometry/inpolygon.m
    Useful TexInfo commands:
    - ``@deftypefn`` ::
    Define a function that can be called. Example code:..
    ``@deftypefn{Function File} {@var{out} =} caosdb_exec (@var{arg})``
    % This file is a part of the CaosDB Project.
    %
    % Copyright (C) 2021 IndiScale GmbH <info@indiscale.com>
    % Copyright (C) 2021 Daniel Hornung <d.hornung@indiscale.com>
    %
    % This file is a part of the CaosDB Project.
    %
    % This program is free software: you can redistribute it and/or modify
    % it under the terms of the GNU Affero General Public License as
    % published by the Free Software Foundation, either version 3 of the
    ......@@ -19,7 +19,7 @@
    % -*- texinfo -*-
    % @deftypefn {Function File} {@var{out} =} caosdb_exec (arg)
    % @cindex index term
    % Calls the equivalkent of the @code{caosdb} command line interface executable. Mostly, this can
    % Calls the equivalent of the @code{caosdb} command line interface executable. Mostly, this can
    % output the version of libcaosdb.
    %
    % Typical arguments are @code{"--version"} or @code{"--test-connection"}.
    ......
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment