Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-julialib
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-julialib
Commits
168e4c26
Commit
168e4c26
authored
3 years ago
by
florian
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Move API to separate section
parent
b89659e1
No related branches found
No related tags found
1 merge request
!6
DOC: Add sections to documentation
Pipeline
#11309
passed
3 years ago
Stage: info
Stage: code-style
Stage: setup
Stage: test
Stage: deploy
Pipeline: CaosDB Julia Integration Tests
#11318
Changes
4
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
docs/make.jl
+10
-1
10 additions, 1 deletion
docs/make.jl
docs/src/api.md
+20
-0
20 additions, 0 deletions
docs/src/api.md
docs/src/assets/logo.svg
+1
-0
1 addition, 0 deletions
docs/src/assets/logo.svg
docs/src/index.md
+7
-22
7 additions, 22 deletions
docs/src/index.md
with
38 additions
and
23 deletions
docs/make.jl
+
10
−
1
View file @
168e4c26
using
Documenter
,
CaosDB
makedocs
(
modules
=
[
CaosDB
],
sitename
=
"CaosDB.jl Documentation"
)
makedocs
(
modules
=
[
CaosDB
],
sitename
=
"CaosDB.jl"
,
format
=
Documenter
.
HTML
(
prettyurls
=
false
),
pages
=
[
"Home"
=>
"index.md"
,
"Getting started"
=>
"README_SETUP.md"
,
"Library"
=>
"api.md"
,
],
)
This diff is collapsed.
Click to expand it.
docs/src/api.md
0 → 100644
+
20
−
0
View file @
168e4c26
# CaosDB.jl's API
Below you find the explicit documentation of CaosDB's public
interface. You also find the documentation of the internal API which
is meant for expert use only. Only use those if you know what you're
doing.
## Public API
```
@autodocs
Modules=[CaosDB, CaosDB.Exceptions, CaosDB.Info, CaosDB.Utility, CaosDB.Connection, CaosDB.Authentication, CaosDB.Entity]
Private=false
```
## Expert-use only API functions
```
@autodocs
Modules=[CaosDB, CaosDB.Exceptions, CaosDB.Info, CaosDB.Utility, CaosDB.Connection, CaosDB.Authentication, CaosDB.Entity]
Public=false
```
This diff is collapsed.
Click to expand it.
docs/src/assets/logo.svg
0 → 100644
+
1
−
0
View file @
168e4c26
<svg
id=
"svg865"
xmlns=
"http://www.w3.org/2000/svg"
viewBox=
"0 0 124.63 117.57"
><defs><style>
.cls-1,.cls-3{fill:#fff;}.cls-1,.cls-2,.cls-3{stroke:#0a8791;}.cls-1,.cls-2{stroke-miterlimit:2.41;stroke-width:2.58px;}.cls-2{fill:#0a8791;}.cls-3{stroke-miterlimit:2.41;stroke-width:2.58px;}
</style></defs><g
id=
"layer1"
><g
id=
"g926"
><ellipse
id=
"ellipse917"
class=
"cls-1"
cx=
"75.88"
cy=
"92.55"
rx=
"47.46"
ry=
"23.73"
/><ellipse
id=
"ellipse920"
class=
"cls-1"
cx=
"75.88"
cy=
"72.26"
rx=
"47.46"
ry=
"23.73"
/><ellipse
id=
"ellipse922"
class=
"cls-2"
cx=
"48.75"
cy=
"50.9"
rx=
"47.46"
ry=
"23.73"
/><ellipse
id=
"ellipse924"
class=
"cls-3"
cx=
"85.19"
cy=
"36.85"
rx=
"23.73"
ry=
"47.46"
transform=
"translate(19.98 100.41) rotate(-75.49)"
/></g></g></svg>
\ No newline at end of file
This diff is collapsed.
Click to expand it.
docs/src/index.md
+
7
−
22
View file @
168e4c26
# CaosDB.jl documentation
This will be the index of the documentation of the CaosDB Julia client
library.
Welcome to CaosDB.jl, the Julia Client for
[
CaosDB
](
https://caosdb.org
)
, the opensource research data management
system. In here you find instruction on how to
[
Set-up
CaosDB.jl
](
@ref
)
and an overview of
[
CaosDB.jl's API
](
@ref
)
.
Manually add a docstring here:
## Contents
```
@docs
CaosDB.Utility.get_env_var(::AbstractString, ::AbstractString)
```
## Public API
Similar to autodoc:
```
@autodocs
Modules=[CaosDB, CaosDB.Info, CaosDB.Utility, CaosDB.Connection, CaosDB.Authentication, CaosDB.Entity]
Private=false
```
## Expert-use only API functions
```
@autodocs
Modules=[CaosDB, CaosDB.Info, CaosDB.Utility, CaosDB.Connection, CaosDB.Authentication, CaosDB.Entity]
Public=false
```
@contents
Pages = ["README_SETUP.md", "api.md"]
```
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