Skip to content

More discrete source links #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 29, 2022
Merged

More discrete source links #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1274af8
Link source as an emoji next to the var name
helins Sep 28, 2022
e52dd56
Print separators between namespaces
helins Sep 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions src/quickdoc/impl.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
source-uri]}]
(cond repo
(format
"<sub>[source](%s/blob/%s/%s#L%s-L%s)</sub>"
"%s/blob/%s/%s#L%s-L%s"
repo
branch
(:filename var)
Expand Down Expand Up @@ -100,16 +100,18 @@
docstring)))

(defn print-var [ns->vars ns-name var _source {:keys [collapse-vars] :as opts}]
(println)
(when (var-filter var)
(when collapse-vars (println "<details>\n\n"))
(when collapse-vars
(println (str "<summary><code>" (:name var) "</code>"
(when-let [summary (var-summary var)]
(str " - " summary)))
"</summary>\n\n"))
(println "##" (format "<a name=\"%s/%s\">`%s`</a>"
(println "##" (format "<a name=\"%s/%s\">[:page_facing_up:](%s) `%s`</a>"
ns-name
(:name var)
(var-source var opts)
(:name var)))
(when-let [arg-lists (or (when-let [quoted-arglists (-> var :meta :arglists)]
(if (and (seq? quoted-arglists)
Expand All @@ -126,20 +128,20 @@
(list (str (:name var) arglist)))
arglist (binding [pprint/*print-miser-width* nil
pprint/*print-right-margin* 120]
(with-out-str (pprint/pprint arglist)))
]
(print arglist)))
(println "```\n"))
(when-let [doc (:doc var)]
(println)
(when (:macro var)
(println "Macro.\n\n"))
(print-docstring ns->vars ns-name doc opts)
(print "<br>"))
(println (var-source var opts))
(when collapse-vars (println "</details>\n\n"))))
(with-out-str (pprint/pprint arglist)))
]
(print arglist)))
(println "```\n"))
(when-let [doc (:doc var)]
(println)
(when (:macro var)
(println "Macro.\n\n"))
(print-docstring ns->vars ns-name doc opts)
(when collapse-vars (println "</details>\n\n")))))

(defn print-namespace [ns-defs ns->vars ns-name vars opts overrides]
(println)
(println "-----")
(let [ns (get-in ns-defs [ns-name 0])
filename (:filename ns)
source (try (slurp filename)
Expand Down