more fixes to doc build

thchr · Dec 20, 2023 · b245fac · b245fac
1 parent 350449b
commit b245fac
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/Bravais/src/types.jl b/Bravais/src/types.jl
@@ -101,6 +101,11 @@ end
 
 # ---------------------------------------------------------------------------------------- #
 
+"""
+    AbstractPoint{D, T} <: StaticVector{D, T}
+
+Abstract supertype of a `D`-dimensional point with elements of type `T`.
+"""
 abstract type AbstractPoint{D, T} <: StaticVector{D, T} end
 
 parent(p::AbstractPoint) = p.v

diff --git a/docs/make.jl b/docs/make.jl
@@ -25,7 +25,14 @@ makedocs(
         "Lattices"              => "lattices.md",
         "API"                   => "api.md",
         "Internal API"          => "internal-api.md",
-    ]
+    ],
+    warnonly = Documenter.except(
+        :autodocs_block, :cross_references, :docs_block, :doctest, :eval_block, 
+        :example_block, :footnote, :linkcheck_remotes, :linkcheck, :meta_block, 
+        :parse_error, :setup_block,
+        #:missing_docs # necessary due to docstrings from SmithNormalForm vendoring :(
+    ),
+    clean = true
 )
 
 # Documenter can also automatically deploy documentation to gh-pages.

diff --git a/docs/src/bravais.md b/docs/src/bravais.md
@@ -35,10 +35,7 @@ reciprocalbasis
 ### Transformations
 ```@docs
 primitivebasismatrix
-transform(::DirectBasis, ::AbstractMatrix{<:Real})
-transform(::ReciprocalBasis, ::AbstractMatrix{<:Real})
-transform(::DirectPoint, ::AbstractMatrix{<:Real})
-transform(::ReciprocalPoint, ::AbstractMatrix{<:Real})
+transform
 primitivize(::Union{AbstractBasis, AbstractPoint}, ::Union{Char, <:Integer})
 primitivize(::DirectBasis, ::Union{Char, <:Integer})
 primitivize(::ReciprocalBasis, ::Union{Char, <:Integer})