Skip to content

Commit b245fac

Browse files
committed
more fixes to doc build
1 parent 350449b commit b245fac

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

Bravais/src/types.jl

+5
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ end
101101

102102
# ---------------------------------------------------------------------------------------- #
103103

104+
"""
105+
AbstractPoint{D, T} <: StaticVector{D, T}
106+
107+
Abstract supertype of a `D`-dimensional point with elements of type `T`.
108+
"""
104109
abstract type AbstractPoint{D, T} <: StaticVector{D, T} end
105110

106111
parent(p::AbstractPoint) = p.v

docs/make.jl

+8-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,14 @@ makedocs(
2525
"Lattices" => "lattices.md",
2626
"API" => "api.md",
2727
"Internal API" => "internal-api.md",
28-
]
28+
],
29+
warnonly = Documenter.except(
30+
:autodocs_block, :cross_references, :docs_block, :doctest, :eval_block,
31+
:example_block, :footnote, :linkcheck_remotes, :linkcheck, :meta_block,
32+
:parse_error, :setup_block,
33+
#:missing_docs # necessary due to docstrings from SmithNormalForm vendoring :(
34+
),
35+
clean = true
2936
)
3037

3138
# Documenter can also automatically deploy documentation to gh-pages.

docs/src/bravais.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,7 @@ reciprocalbasis
3535
### Transformations
3636
```@docs
3737
primitivebasismatrix
38-
transform(::DirectBasis, ::AbstractMatrix{<:Real})
39-
transform(::ReciprocalBasis, ::AbstractMatrix{<:Real})
40-
transform(::DirectPoint, ::AbstractMatrix{<:Real})
41-
transform(::ReciprocalPoint, ::AbstractMatrix{<:Real})
38+
transform
4239
primitivize(::Union{AbstractBasis, AbstractPoint}, ::Union{Char, <:Integer})
4340
primitivize(::DirectBasis, ::Union{Char, <:Integer})
4441
primitivize(::ReciprocalBasis, ::Union{Char, <:Integer})

0 commit comments

Comments
 (0)