mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2024-12-11 09:10:27 +00:00
Code Issues 1 Releases Wiki Activity
67a8c6df09
janet/tools/gendoc.janet

115 lines
2.8 KiB
Plaintext
Raw Normal View History

Fix some documentation and add beginning of a document generating script.
2018-12-16 04:19:28 +00:00
# Generate documentation
(def- prelude
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
```
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Janet Language Documentation</title>
<meta name="description" content="API Documentation for the janet programming language.">
<style>
Update documentation to include source location of bindings.
2018-12-17 17:06:50 +00:00
.docstring {
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
font-family: monospace;
}
Update documentation to include source location of bindings.
2018-12-17 17:06:50 +00:00
.binding-type {
color: blue;
}
.source-map {
color: steelblue;
font-size: 0.8em;
}
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
</style>
</head>
```)
Fix some documentation and add beginning of a document generating script.
2018-12-16 04:19:28 +00:00
(def- postlude
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
```
</html>
```)
Fix some documentation and add beginning of a document generating script.
2018-12-16 04:19:28 +00:00
(def- escapes
{10 "<br>"
09 "&nbsp;&nbsp;&nbsp;&nbsp;"
38 "&amp;"
60 "&lt;"
62 "&gt;"
34 "&quot;"
39 "&#39;"
47 "&#47;"})
(defn- trim-lead
"Trim leading newlines"
[str]
(var i 0)
Add functionality that allows the set macro to take a tuple as an l-value. Remove the old multi-sym report in anticipation of a different mechanism.
2019-01-07 00:33:27 +00:00
(while (= 10 (get str i)) (++ i))
Fix some documentation and add beginning of a document generating script.
2018-12-16 04:19:28 +00:00
(string/slice str i))
(defn- html-escape
"Escape special characters for HTML encoding."
[str]
(def buf @"")
(loop [byte :in str]
Add functionality that allows the set macro to take a tuple as an l-value. Remove the old multi-sym report in anticipation of a different mechanism.
2019-01-07 00:33:27 +00:00
(if-let [rep (get escapes byte)]
Fix some documentation and add beginning of a document generating script.
2018-12-16 04:19:28 +00:00
(buffer/push-string buf rep)
(buffer/push-byte buf byte)))
buf)
Fix gendoc.
2019-02-16 23:35:29 +00:00
(def- months '("January" "February" "March" "April" "May" "June" "July" "August" "September"
"October" "November" "December"))
(defn nice-date
"Get the current date nicely formatted"
[]
(let [date (os/date)
M (months (date :month))
D (+ (date :month-day) 1)
Y (date :year)
HH (date :hours)
MM (date :minutes)
SS (date :seconds)]
(string/format "%s %d, %d at %.2d:%.2d:%.2d"
M D Y HH MM SS)))
Update documentation.
2018-12-17 06:57:09 +00:00
(defn- make-title
"Generate title"
[]
(string "<h1>Janet Core API</h1>"
Update os/stat os/stat can now take a keyword as the second argument to avoid creating a table if one only wants on value from stat.
2019-04-01 15:11:15 +00:00
"<p>Version " janet/version "-" janet/build "</p>"
Remove extra 'at' in generated doc.
2019-02-16 23:38:34 +00:00
"<p>Generated "
Fix gendoc.
2019-02-16 23:35:29 +00:00
(nice-date)
Remove some more extra text in core api doc.
2019-02-16 23:39:44 +00:00
"</p>"
Update documentation.
2018-12-17 06:57:09 +00:00
"<hr>"))
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
(defn- emit-item
"Generate documentation for one entry."
[key env-entry]
(let [{:macro macro
:value val
:ref ref
Update documentation to include source location of bindings.
2018-12-17 17:06:50 +00:00
:source-map sm
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
:doc docstring} env-entry
Add anchors in generated docs This allows us to link to specific functions.
2019-01-26 15:12:33 +00:00
html-key (html-escape key)
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
binding-type (cond
macro :macro
Update buffer/push-integer to buffer/push-word.
2018-12-29 18:07:18 +00:00
ref (string :var " (" (type (get ref 0)) ")")
Update documentation to include source location of bindings.
2018-12-17 17:06:50 +00:00
(type val))
source-ref (if-let [[path start end] sm]
(string "<span class=\"source-map\">" path " (" start ":" end ")</span>")
"")]
Add anchors in generated docs This allows us to link to specific functions.
2019-01-26 15:12:33 +00:00
(string "<h2 class=\"binding\"><a id=\"" key "\">" html-key "</a></h2>\n"
Update documentation to include source location of bindings.
2018-12-17 17:06:50 +00:00
"<span class=\"binding-type\">" binding-type "</span>\n"
"<p class=\"docstring\">" (trim-lead (html-escape docstring)) "</p>\n"
source-ref)))
Fix some documentation and add beginning of a document generating script.
2018-12-16 04:19:28 +00:00
Update gendoc and fix issue with run-context.
2018-12-16 18:17:30 +00:00
# Generate parts and print them to stdout
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
(def parts (seq [[k entry]
Many changes for adding dynamic (fiber-level) scope. - Allow passing a table to fibers, which make fiber level scope easier. - Add fiber/getenv, fiber/setenv, dyn, and setdyn - Remove meta, *env*, and *doc-width* - Some functions changed dignatures, and no longer take an env
2019-04-16 19:41:45 +00:00
:in (sort (pairs (table/getproto (fiber/getenv (fiber/current)))))
Fix doc generation.
2019-06-19 13:48:33 +00:00
:when (symbol? k)
Add functionality that allows the set macro to take a tuple as an l-value. Remove the old multi-sym report in anticipation of a different mechanism.
2019-01-07 00:33:27 +00:00
:when (and (get entry :doc) (not (get entry :private)))]
Add docs target to generate documentation.
2018-12-17 06:41:11 +00:00
(emit-item k entry)))
Update documentation.
2018-12-17 06:57:09 +00:00
(print
prelude
(make-title)
Update documentation to include source location of bindings.
2018-12-17 17:06:50 +00:00
;(interpose "<hr>\n" parts)
Update documentation.
2018-12-17 06:57:09 +00:00
postlude)
Reference in New Issue Copy Permalink