more fixes to doc build

docs/make.jl

@@ -23,7 +23,8 @@ makedocs(
         "Bravais types & bases" => "bravais.md",
         "Band representations"  => "bandreps.md",
         "Lattices"              => "lattices.md",
-        "API"                   => "api.md"
+        "API"                   => "api.md",
+        "Internal API"          => "internal-api.md",
     ]
 )
 

docs/src/api.md

@@ -1,4 +1,4 @@
-# API
+# Public API
 
 ---
 
@@ -25,9 +25,4 @@ Order   = [:function]
 Modules = [Crystalline]
 Private = false
 Order   = [:constant]
-```
-
-## Unexported functionality
-```@docs
-Crystalline.AbstractGroup{D}
 ```

docs/src/index.md

@@ -15,5 +15,6 @@ Pages = ["operations.md",
          "bravais.md",
          "bandreps.md",
          "lattices.md",
-         "api.md"]
+         "api.md",
+         "internal-api.md"]
 ```

docs/src/internal-api.md

@@ -0,0 +1,16 @@
+# Internal API
+
+This page lists unexported functionality from Crystalline, that may be of interest to developers.
+
+---
+
+```@meta
+CurrentModule = Crystalline
+```
+
+## Unexported, internal functionality
+```@autodocs
+Modules = [Crystalline]
+Private = true
+Order   = [:type, :function, :constant]
+```

src/Crystalline.jl

@@ -84,8 +84,7 @@ export @S_str, spacegroup, compose,
        pointgroup,
        reduce_ops,
        issubgroup, isnormal,
-       generate, generators,
-       position # to appear in docs, must be re-exported, even though it extends Base
+       generate, generators
 
 include("conjugacy.jl") # construction of conjugacy classes
 export classes, is_abelian
@@ -140,6 +139,10 @@ export SubperiodicGroup, subperiodicgroup
 include("grouprelations/grouprelations.jl")
 export maximal_subgroups, minimal_supergroups
 
+# some functions are extensions of base-owned names; we need to (re)export them in order to 
+# get the associated docstrings listed by Documeter.jl
+export position, inv
+
 # ---------------------------------------------------------------------------------------- #
 # EXTENSIONS AND JLD-FILE INITIALIZATION
 if !isdefined(Base, :get_extension)