bookshelf-doc/DocGen4/Output.lean

144 lines
5.0 KiB
Plaintext
Raw Normal View History

2021-12-12 12:21:53 +00:00
/-
Copyright (c) 2021 Henrik Böving. All rights reserved.
Released under Apache 2.0 license as described in the file LICENSE.
Authors: Henrik Böving
-/
import Lean
2022-03-06 17:51:06 +00:00
import Lake
2021-12-12 12:21:53 +00:00
import DocGen4.Process
import DocGen4.Output.Base
import DocGen4.Output.Index
import DocGen4.Output.Module
import DocGen4.Output.NotFound
2022-02-13 14:42:15 +00:00
import DocGen4.Output.Find
import DocGen4.Output.SourceLinker
import DocGen4.Output.ToJson
2022-07-26 10:52:41 +00:00
import DocGen4.LeanInk.Process
import Std.Data.HashMap
2021-12-12 12:21:53 +00:00
namespace DocGen4
open Lean IO System Output Process Std
2021-12-13 12:00:53 +00:00
def htmlOutputSetup (config : SiteBaseContext) : IO Unit := do
let findBasePath := basePath / "find"
-- Base structure
2022-02-13 14:42:15 +00:00
FS.createDirAll basePath
FS.createDirAll findBasePath
FS.createDirAll srcBasePath
FS.createDirAll declarationsBasePath
2022-02-13 14:42:15 +00:00
-- All the doc-gen static stuff
let indexHtml := ReaderT.run index config |>.toString
let notFoundHtml := ReaderT.run notFound config |>.toString
let navbarHtml := ReaderT.run navbar config |>.toString
let docGenStatic := #[
("style.css", styleCss),
("declaration-data.js", declarationDataCenterJs),
("nav.js", navJs),
("how-about.js", howAboutJs),
("search.js", searchJs),
("mathjax-config.js", mathjaxConfigJs),
("instances.js", instancesJs),
2022-07-22 14:15:37 +00:00
("importedBy.js", importedByJs),
("index.html", indexHtml),
("404.html", notFoundHtml),
("navbar.html", navbarHtml)
]
for (fileName, content) in docGenStatic do
FS.writeFile (basePath / fileName) content
let findHtml := ReaderT.run find { config with depthToRoot := 1 } |>.toString
let findStatic := #[
("index.html", findHtml),
("find.js", findJs)
]
for (fileName, content) in findStatic do
FS.writeFile (findBasePath / fileName) content
2022-02-22 04:40:14 +00:00
let alectryonStatic := #[
("alectryon.css", alectryonCss),
("alectryon.js", alectryonJs),
("docutils_basic.css", docUtilsCss),
("pygments.css", pygmentsCss)
]
for (fileName, content) in alectryonStatic do
FS.writeFile (srcBasePath / fileName) content
2022-02-20 17:12:49 +00:00
2022-07-21 20:43:33 +00:00
def htmlOutputDeclarationDatas (result : AnalyzerResult) : HtmlT IO Unit := do
for (_, mod) in result.moduleInfo.toArray do
let jsonDecls ← Module.toJson mod
FS.writeFile (declarationsBasePath / s!"declaration-data-{mod.name}.bmp") (toJson jsonDecls).compress
2022-07-21 20:43:33 +00:00
2022-07-26 11:56:22 +00:00
def htmlOutputResults (baseConfig : SiteBaseContext) (result : AnalyzerResult) (ws : Lake.Workspace) (ink : Bool) : IO Unit := do
let config : SiteContext := {
result := result,
2022-07-21 00:25:26 +00:00
sourceLinker := ←sourceLinker ws
2022-07-26 11:56:22 +00:00
leanInkEnabled := ink
}
2022-07-21 17:07:35 +00:00
FS.createDirAll basePath
FS.createDirAll declarationsBasePath
2022-07-21 17:07:35 +00:00
-- Rendering the entire lean compiler takes time....
--let sourceSearchPath := ((←Lean.findSysroot) / "src" / "lean") :: ws.root.srcDir :: ws.leanSrcPath
let sourceSearchPath := ws.root.srcDir :: ws.leanSrcPath
2022-07-23 11:01:25 +00:00
discard <| htmlOutputDeclarationDatas result |>.run config baseConfig
2022-06-20 16:39:55 +00:00
for (modName, module) in result.moduleInfo.toArray do
let fileDir := moduleNameToDirectory basePath modName
let filePath := moduleNameToFile basePath modName
-- path: 'basePath/module/components/till/last.html'
-- The last component is the file name, so we drop it from the depth to root.
2022-07-26 10:52:41 +00:00
let baseConfig := { baseConfig with
depthToRoot := modName.components.dropLast.length
currentName := some modName
}
let moduleHtml := moduleToHtml module |>.run config baseConfig
2022-07-23 11:01:25 +00:00
FS.createDirAll fileDir
FS.writeFile filePath moduleHtml.toString
2022-07-26 11:56:22 +00:00
if ink then
2022-06-20 16:39:55 +00:00
if let some inputPath ← Lean.SearchPath.findModuleWithExt sourceSearchPath "lean" module.name then
IO.println s!"Inking: {modName.toString}"
-- path: 'basePath/src/module/components/till/last.html'
-- The last component is the file name, however we are in src/ here so dont drop it this time
2022-07-26 10:52:41 +00:00
let baseConfig := {baseConfig with depthToRoot := modName.components.length }
Process.LeanInk.runInk inputPath |>.run config baseConfig
2021-12-12 12:21:53 +00:00
def getSimpleBaseContext (hierarchy : Hierarchy) : SiteBaseContext :=
{
depthToRoot := 0,
currentName := none,
hierarchy
}
2022-07-21 19:12:15 +00:00
def htmlOutputIndex (baseConfig : SiteBaseContext) : IO Unit := do
2022-07-21 17:07:35 +00:00
htmlOutputSetup baseConfig
2022-07-23 18:40:08 +00:00
let mut index : JsonIndex := { }
for entry in ←System.FilePath.readDir declarationsBasePath do
if entry.fileName.startsWith "declaration-data-" && entry.fileName.endsWith ".bmp" then
let fileContent ← FS.readFile entry.path
let .ok jsonContent := Json.parse fileContent | unreachable!
let .ok (module : JsonModule) := fromJson? jsonContent | unreachable!
2022-07-23 18:40:08 +00:00
index := index.addModule module |>.run baseConfig
let finalJson := toJson index
-- The root JSON for find
FS.writeFile (declarationsBasePath / "declaration-data.bmp") finalJson.compress
/--
The main entrypoint for outputting the documentation HTML based on an
`AnalyzerResult`.
-/
2022-07-26 11:56:22 +00:00
def htmlOutput (result : AnalyzerResult) (hierarchy : Hierarchy) (ws : Lake.Workspace) (ink : Bool) : IO Unit := do
let baseConfig := getSimpleBaseContext hierarchy
2022-07-26 11:56:22 +00:00
htmlOutputResults baseConfig result ws ink
2022-07-21 19:12:15 +00:00
htmlOutputIndex baseConfig
2021-12-12 12:21:53 +00:00
end DocGen4