Skip to content
Snippets Groups Projects
Commit 168e4c26 authored by florian's avatar florian
Browse files

DOC: Move API to separate section

parent b89659e1
No related branches found
No related tags found
1 merge request!6DOC: Add sections to documentation
Pipeline #11309 passed
Pipeline: CaosDB Julia Integration Tests

#11318

    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",
    ],
    )
    # 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
    ```
    <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
    # 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"]
    ```
    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