Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
CaosDB Octave library
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
CaosDB Octave library
Commits
63f4e587
Commit
63f4e587
authored
3 years ago
by
Daniel Hornung
Browse files
Options
Downloads
Patches
Plain Diff
DOC: CHANGELOG and documentation generation.
parent
fe0f8cdc
No related branches found
No related tags found
1 merge request
!3
Full functionality of libcaosdb
Pipeline
#12994
passed
3 years ago
Stage: setup
Stage: test
Stage: deploy
Pipeline: caosdb-octaveinttest
#12996
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
CHANGELOG.md
+2
-0
2 additions, 0 deletions
CHANGELOG.md
doc/Development.rst
+21
-7
21 additions, 7 deletions
doc/Development.rst
src/caosdb_exec.m
+3
-3
3 additions, 3 deletions
src/caosdb_exec.m
with
26 additions
and
10 deletions
CHANGELOG.md
+
2
−
0
View file @
63f4e587
...
...
@@ -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 ###
...
...
This diff is collapsed.
Click to expand it.
doc/Development.rst
+
21
−
7
View file @
63f4e587
===========
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 diff is collapsed.
Click to expand it.
src/caosdb_exec.m
+
3
−
3
View file @
63f4e587
%
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
equival
k
ent
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"
}.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment