Skip to content

Commit

Permalink
update for Documenter 1
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander-Barth committed Sep 22, 2023
1 parent 5a60b1e commit 8e6cc61
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
5 changes: 3 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
using Pkg
Pkg.activate(@__DIR__)
CI = get(ENV, "CI", nothing) == "true"
using Documenter, NCDatasets
using Documenter, NCDatasets, CommonDataModel

makedocs(
modules = [NCDatasets],
modules = [NCDatasets, CommonDataModel],
sitename= "NCDatasets.jl",
doctest = false,
format = Documenter.HTML(
Expand All @@ -21,6 +21,7 @@ makedocs(
"Experimental features" => "experimental.md",
"Tutorials" => "tutorials.md",
],
checkdocs = :none,
)

if CI
Expand Down
3 changes: 1 addition & 2 deletions docs/src/dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ Otherwise, we attempt to use standard structures from the Julia standard library
## Groups

```@docs
defGroup(ds::NCDataset,groupname)
defGroup
getindex(g::NCDatasets.Groups,groupname::AbstractString)
Base.keys(g::NCDatasets.Groups)
groupname(ds::NCDataset)
```

## Common methods
Expand Down
2 changes: 1 addition & 1 deletion src/groupes.jl
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ function Base.getindex(g::Groups,groupname::SymbolOrString)
end

"""
defGroup(ds::NCDataset,groupname, attrib = []))
defGroup(ds::NCDataset,groupname; attrib = []))
Create the group with the name `groupname` in the dataset `ds`.
`attrib` is a list of attribute name and attribute value pairs (see `NCDataset`).
Expand Down

0 comments on commit 8e6cc61

Please sign in to comment.