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
|
|
|
|
|
|
import Std.Data.HashMap
|
|
|
|
|
|
import DocGen4.Process
|
|
|
|
|
|
import DocGen4.ToHtmlFormat
|
|
|
|
|
|
import DocGen4.IncludeStr
|
|
|
|
|
|
|
|
|
|
|
|
namespace DocGen4
|
|
|
|
|
|
|
|
|
|
|
|
open Lean Std
|
|
|
|
|
|
open scoped DocGen4.Jsx
|
2021-12-13 12:00:53 +00:00
|
|
|
|
open IO System
|
2021-12-12 12:21:53 +00:00
|
|
|
|
|
|
|
|
|
|
structure SiteContext where
|
|
|
|
|
|
root : String
|
|
|
|
|
|
result : AnalyzerResult
|
2021-12-13 20:27:08 +00:00
|
|
|
|
currentName : Option Name
|
|
|
|
|
|
|
|
|
|
|
|
def setCurrentName (name : Name) (ctx : SiteContext) := {ctx with currentName := some name}
|
2021-12-12 12:21:53 +00:00
|
|
|
|
|
|
|
|
|
|
abbrev HtmlM := Reader SiteContext
|
|
|
|
|
|
|
|
|
|
|
|
def getRoot : HtmlM String := do (←read).root
|
|
|
|
|
|
def getResult : HtmlM AnalyzerResult := do (←read).result
|
2021-12-13 20:27:08 +00:00
|
|
|
|
def getCurrentName : HtmlM (Option Name) := do (←read).currentName
|
2021-12-12 12:21:53 +00:00
|
|
|
|
|
|
|
|
|
|
def templateExtends {α β : Type} (base : α → HtmlM β) (new : HtmlM α) : HtmlM β :=
|
|
|
|
|
|
new >>= base
|
|
|
|
|
|
|
2021-12-13 12:00:53 +00:00
|
|
|
|
def nameToUrl (n : Name) : String :=
|
2021-12-12 12:33:24 +00:00
|
|
|
|
(parts.intersperse "/").foldl (· ++ ·) "" ++ ".html"
|
|
|
|
|
|
where
|
|
|
|
|
|
parts := n.components.map Name.toString
|
2021-12-12 12:21:53 +00:00
|
|
|
|
|
2021-12-13 12:00:53 +00:00
|
|
|
|
def nameToDirectory (basePath : FilePath) (n : Name) : FilePath :=
|
|
|
|
|
|
basePath / parts.foldl (λ acc p => acc / FilePath.mk p) (FilePath.mk ".")
|
|
|
|
|
|
where
|
|
|
|
|
|
parts := n.components.dropLast.map Name.toString
|
|
|
|
|
|
|
2021-12-13 19:47:52 +00:00
|
|
|
|
def moduleListFile (file : Name) : HtmlM Html := do
|
2021-12-13 20:27:08 +00:00
|
|
|
|
let attributes := match ←getCurrentName with
|
|
|
|
|
|
| some name =>
|
|
|
|
|
|
if file == name then
|
|
|
|
|
|
#[("class", "nav_link"), ("visible", "")]
|
|
|
|
|
|
else
|
|
|
|
|
|
#[("class", "nav_link")]
|
|
|
|
|
|
| none => #[("class", "nav_link")]
|
|
|
|
|
|
let nodes := #[<a href={s!"{←getRoot}{nameToUrl file}"}>{file.toString}</a>]
|
|
|
|
|
|
return Html.element "div" attributes nodes
|
2021-12-13 19:47:52 +00:00
|
|
|
|
|
|
|
|
|
|
partial def moduleListDir (h : Hierarchy) : HtmlM Html := do
|
|
|
|
|
|
let children := Array.mk (h.getChildren.toList.map Prod.snd)
|
|
|
|
|
|
let dirs := children.filter (λ c => c.getChildren.toList.length != 0)
|
|
|
|
|
|
let files := children.filter Hierarchy.isFile |>.map Hierarchy.getName
|
2021-12-13 20:27:08 +00:00
|
|
|
|
let dirNodes ← (dirs.mapM moduleListDir)
|
|
|
|
|
|
let fileNodes ← (files.mapM moduleListFile)
|
|
|
|
|
|
let attributes := match ←getCurrentName with
|
|
|
|
|
|
| some name =>
|
|
|
|
|
|
if h.getName.isPrefixOf name then
|
|
|
|
|
|
#[("class", "nav_sect"), ("data-path", nameToUrl h.getName), ("open", "")]
|
|
|
|
|
|
else
|
|
|
|
|
|
#[("class", "nav_sect"), ("data-path", nameToUrl h.getName)]
|
|
|
|
|
|
| none =>
|
|
|
|
|
|
#[("class", "nav_sect"), ("data-path", nameToUrl h.getName)]
|
|
|
|
|
|
let nodes := #[<summary>{h.getName.toString}</summary>] ++ dirNodes ++ fileNodes
|
|
|
|
|
|
return Html.element "details" attributes nodes
|
2021-12-12 12:21:53 +00:00
|
|
|
|
|
|
|
|
|
|
def moduleList : HtmlM (Array Html) := do
|
|
|
|
|
|
let hierarchy := (←getResult).hierarchy
|
|
|
|
|
|
let mut list := Array.empty
|
|
|
|
|
|
for (n, cs) in hierarchy.getChildren do
|
|
|
|
|
|
list := list.push <h4>{n.toString}</h4>
|
2021-12-13 19:47:52 +00:00
|
|
|
|
list := list.push $ ←moduleListDir cs
|
2021-12-12 12:21:53 +00:00
|
|
|
|
list
|
|
|
|
|
|
|
|
|
|
|
|
def navbar : HtmlM Html := do
|
|
|
|
|
|
<nav «class»="nav">
|
|
|
|
|
|
<h3>General documentation</h3>
|
|
|
|
|
|
<div «class»="nav_link"><a href={s!"{←getRoot}"}>index</a></div>
|
|
|
|
|
|
/-
|
|
|
|
|
|
TODO: Add these in later
|
|
|
|
|
|
<div «class»="nav_link"><a href={s!"{←getRoot}tactics.html"}>tactics</a></div>
|
|
|
|
|
|
<div «class»="nav_link"><a href={s!"{←getRoot}commands.html"}>commands</a></div>
|
|
|
|
|
|
<div «class»="nav_link"><a href={s!"{←getRoot}hole_commands.html"}>hole commands</a></div>
|
|
|
|
|
|
<div «class»="nav_link"><a href={s!"{←getRoot}attributes.html"}>attributes</a></div>
|
|
|
|
|
|
<div «class»="nav_link"><a href={s!"{←getRoot}notes.html"}>notes</a></div>
|
|
|
|
|
|
<div «class»="nav_link"><a href={s!"{←getRoot}references.html"}>references</a></div>
|
|
|
|
|
|
-/
|
|
|
|
|
|
<h3>Library</h3>
|
|
|
|
|
|
[←moduleList]
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
|
|
def baseHtml (title : String) (site : Html) : HtmlM Html := do
|
|
|
|
|
|
<html lang="en">
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<link rel="stylesheet" href={s!"{←getRoot}style.css"}/>
|
|
|
|
|
|
<link rel="stylesheet" href={s!"{←getRoot}pygments.css"}/>
|
|
|
|
|
|
<link rel="shortcut icon" href={s!"{←getRoot}favicon.ico"}/>
|
|
|
|
|
|
<title>{title}</title>
|
|
|
|
|
|
<meta charset="UTF-8"/>
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
|
|
<input id="nav_toggle" type="checkbox"/>
|
|
|
|
|
|
|
|
|
|
|
|
<header>
|
|
|
|
|
|
<h1><label «for»="nav_toggle"></label>Documentation</h1>
|
|
|
|
|
|
<p «class»="header_filename break_within">{title}</p>
|
|
|
|
|
|
-- TODO: Replace this form with our own search
|
|
|
|
|
|
<form action="https://google.com/search" method="get" id="search_form">
|
|
|
|
|
|
<input type="hidden" name="sitesearch" value="https://leanprover-community.github.io/mathlib_docs"/>
|
|
|
|
|
|
<input type="text" name="q" autocomplete="off"/>
|
|
|
|
|
|
<button>Google site search</button>
|
|
|
|
|
|
</form>
|
|
|
|
|
|
</header>
|
|
|
|
|
|
|
|
|
|
|
|
<nav «class»="internal_nav"></nav>
|
|
|
|
|
|
|
|
|
|
|
|
{site}
|
|
|
|
|
|
|
|
|
|
|
|
{←navbar}
|
|
|
|
|
|
|
2021-12-13 20:36:21 +00:00
|
|
|
|
-- Lean in JS in HTML in Lean...very meta
|
|
|
|
|
|
<script>
|
|
|
|
|
|
siteRoot = "{←getRoot}";
|
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
-- TODO Add more js stuff
|
|
|
|
|
|
<script src={s!"{←getRoot}nav.js"}></script>
|
2021-12-12 12:21:53 +00:00
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
|
|
|
|
|
|
2021-12-13 12:00:53 +00:00
|
|
|
|
def notFound : HtmlM Html := do templateExtends (baseHtml "404") $
|
|
|
|
|
|
<main>
|
|
|
|
|
|
<h1>404 Not Found</h1>
|
|
|
|
|
|
<p> Unfortunately, the page you were looking for is no longer here. </p>
|
|
|
|
|
|
<div id="howabout"></div>
|
|
|
|
|
|
</main>
|
|
|
|
|
|
|
2021-12-12 12:21:53 +00:00
|
|
|
|
def index : HtmlM Html := do templateExtends (baseHtml "Index") $
|
|
|
|
|
|
<main>
|
|
|
|
|
|
<a id="top"></a>
|
|
|
|
|
|
<h1> Welcome to the documentation page </h1>
|
|
|
|
|
|
What is up?
|
|
|
|
|
|
</main>
|
|
|
|
|
|
|
|
|
|
|
|
def styleCss : String := include_str "./static/style.css"
|
2021-12-13 20:36:21 +00:00
|
|
|
|
def navJs : String := include_str "./static/nav.js"
|
2021-12-12 12:21:53 +00:00
|
|
|
|
|
2021-12-13 20:27:08 +00:00
|
|
|
|
def moduleToHtml (module : Module) : HtmlM Html := withReader (setCurrentName module.name) do
|
|
|
|
|
|
templateExtends (baseHtml module.name.toString) $
|
|
|
|
|
|
<main>
|
|
|
|
|
|
<h1>This is the page of {module.name.toString}</h1>
|
|
|
|
|
|
</main>
|
2021-12-13 12:00:53 +00:00
|
|
|
|
|
2021-12-12 12:21:53 +00:00
|
|
|
|
def htmlOutput (result : AnalyzerResult) : IO Unit := do
|
|
|
|
|
|
-- TODO: parameterize this
|
2021-12-13 20:27:08 +00:00
|
|
|
|
let config := { root := "/", result := result, currentName := none}
|
2021-12-12 12:21:53 +00:00
|
|
|
|
let basePath := FilePath.mk "./build/doc/"
|
|
|
|
|
|
let indexHtml := ReaderT.run index config
|
2021-12-13 12:00:53 +00:00
|
|
|
|
let notFoundHtml := ReaderT.run notFound config
|
2021-12-12 12:21:53 +00:00
|
|
|
|
FS.createDirAll basePath
|
|
|
|
|
|
FS.writeFile (basePath / "index.html") indexHtml.toString
|
|
|
|
|
|
FS.writeFile (basePath / "style.css") styleCss
|
2021-12-13 12:00:53 +00:00
|
|
|
|
FS.writeFile (basePath / "404.html") notFoundHtml.toString
|
2021-12-13 20:36:21 +00:00
|
|
|
|
FS.writeFile (basePath / "nav.js") navJs
|
2021-12-13 12:00:53 +00:00
|
|
|
|
for (module, content) in result.modules.toArray do
|
|
|
|
|
|
let moduleHtml := ReaderT.run (moduleToHtml content) config
|
|
|
|
|
|
let path := basePath / (nameToUrl module)
|
|
|
|
|
|
FS.createDirAll $ nameToDirectory basePath module
|
|
|
|
|
|
FS.writeFile path moduleHtml.toString
|
2021-12-12 12:21:53 +00:00
|
|
|
|
|
|
|
|
|
|
end DocGen4
|
|
|
|
|
|
|
