From 54f400e620631e5e3e689d9ecf9aeb3a5fe4c31a Mon Sep 17 00:00:00 2001 From: Daniel <d.hornung@indiscale.com> Date: Fri, 21 Apr 2023 17:57:38 +0200 Subject: [PATCH] DOC: Unrelated small changes. --- src/doc/Data-Model.md | 9 ++++----- src/doc/conf.py | 2 +- src/doc/tutorials/statemachine.rst | 2 +- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/doc/Data-Model.md b/src/doc/Data-Model.md index d11a88f6..b471b824 100644 --- a/src/doc/Data-Model.md +++ b/src/doc/Data-Model.md @@ -15,11 +15,10 @@ contain information about the Record. The following is a more detailed explanation (also see this [paper](https://www.mdpi.com/2306-5729/4/2/83)). -> Record Types and Abstract Properties are used to define the ontology -> for a particular domain in which the RDMS is used. Records are used -> to store the actual data and therefore represent individuals or -> particular things, e.g. a particular experiment, a particular time -> series, etc. +> Record Types and Abstract Properties are used to define the ontology for a particular domain in +> which the RDMS (research data management) is used. Records are used to store the actual data and +> therefore represent individuals or particular things, e.g. a particular experiment, a particular +> time series, etc. ## Record Types diff --git a/src/doc/conf.py b/src/doc/conf.py index 700a0093..43f97aee 100644 --- a/src/doc/conf.py +++ b/src/doc/conf.py @@ -49,7 +49,7 @@ extensions = [ "sphinx.ext.autosectionlabel", # Allow reference sections using its title "sphinx_rtd_theme", "sphinxcontrib.plantuml", # PlantUML diagrams - "sphinx_a4doc", # antl4 + "sphinx_a4doc", # antlr4 ] # Add any paths that contain templates here, relative to this directory. diff --git a/src/doc/tutorials/statemachine.rst b/src/doc/tutorials/statemachine.rst index 31762042..dc46885a 100644 --- a/src/doc/tutorials/statemachine.rst +++ b/src/doc/tutorials/statemachine.rst @@ -30,5 +30,5 @@ of Records that have that parent. For example by executing: .. code-block:: Python rt = db.RecordType("Article").retrieve() - rt.state = db.State(name="UnPublished", model="Publish Life-cycle")`` + rt.state = db.State(name="UnPublished", model="Publish Life-cycle") rt.update() -- GitLab