Skip to content

Commit

Permalink
Autodoc commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@clojure-build
clojure-build committed Jan 1, 2025
1 parent 28e4549 commit d0e3d35
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 31 deletions.
8 changes: 4 additions & 4 deletions api-index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index - tools.deps 0.21.1457-SNAPSHOT API documentation</title>
<title>Index - tools.deps 0.21.1468-SNAPSHOT API documentation</title>
<link rel="icon" href="static/favicon.png" />
<link rel="shortcut icon" href="static/favicon.png" />
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
Expand All @@ -25,7 +25,7 @@ <h1><a href="index.html" id="page-header" title="page header title">tools.deps A
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<span class="toc-header"><span id="project-name">tools.deps</span> <span id="version">0.21.1457-SNAPSHOT</span> API</span><br />
<span class="toc-header"><span id="project-name">tools.deps</span> <span id="version">0.21.1468-SNAPSHOT</span> API</span><br />
<ul>
<li><a href="index.html" class="wiki_link">Overview</a></li>
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
Expand All @@ -41,7 +41,7 @@ <h1><a href="index.html" id="page-header" title="page header title">tools.deps A
<div class="contentBox"><div class="innerContentBox">
<div class="wiki wikiPage" id="content_view">
<div id="right-sidebar"></div>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">tools.deps</span> <span id="header-version">0.21.1457-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">tools.deps</span> <span id="header-version">0.21.1468-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
This page has an alphabetical index of all the documented functions and variables
in <span class="project-name-span">tools.deps</span>.

Expand Down Expand Up @@ -217,7 +217,7 @@ <h2 id="S"><span id="section-head">S</span></h2>
<h2 id="T"><span id="section-head">T</span></h2>
<pre>
<span id="section-content"> <a href="index.html#:clojure.tools.deps.specs/threads">::threads</a><span id="line-content"> spec clojure.tools.deps.specs pos-int?.
</span></span><span id="section-content"> <a href="index.html#clojure.tools.deps/tool">tool</a><span id="line-content"> function clojure.tools.deps Transform project edn for tool by applying tool ar...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.deps/tool">tool</a><span id="line-content"> function clojure.tools.deps Replaces project-edn :deps and :paths with tool :d...
</span></span><span id="section-content"> <a href="index.html#:clojure.tools.deps.specs/tool-args">::tool-args</a><span id="line-content"> spec clojure.tools.deps.specs (keys :opt-un [:clojure.tools.deps.specs/rep...
</span></span><span id="section-content"> <a href="index.html#:clojure.tools.deps.specs/trace">::trace</a><span id="line-content"> spec clojure.tools.deps.specs boolean?.
</span></span><span id="section-content"> <a href="index.html#clojure.tools.deps.tree/trace-&gt;tree">trace-&gt;tree</a><span id="line-content"> function clojure.tools.deps.tree Convert a deps trace data structure into a de...
Expand Down
57 changes: 30 additions & 27 deletions index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>clojure.tools.deps - tools.deps 0.21.1457-SNAPSHOT API documentation</title>
<title>clojure.tools.deps - tools.deps 0.21.1468-SNAPSHOT API documentation</title>
<link rel="icon" href="static/favicon.png" />
<link rel="shortcut icon" href="static/favicon.png" />
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
Expand All @@ -25,7 +25,7 @@ <h1><a href="index.html" id="page-header" title="page header title">tools.deps A
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<span class="toc-header"><span id="project-name">tools.deps</span> <span id="version">0.21.1457-SNAPSHOT</span> API</span><br />
<span class="toc-header"><span id="project-name">tools.deps</span> <span id="version">0.21.1468-SNAPSHOT</span> API</span><br />
<ul>
<li><a href="index.html" class="wiki_link">Overview</a></li>
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
Expand Down Expand Up @@ -250,7 +250,7 @@ <h1 class="nopad">Table of Contents</h1>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="clojure.tools.deps">clojure.tools.deps</span>
- <span id="header-project">tools.deps</span> <span id="header-version">0.21.1457-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
- <span id="header-project">tools.deps</span> <span id="header-version">0.21.1468-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
</h1>

<br />Full namespace name: <span id="long-name">clojure.tools.deps</span>
Expand Down Expand Up @@ -297,7 +297,7 @@ <h2 id="clojure.tools.deps/calc-basis">calc-basis</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L730">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L730">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -310,13 +310,13 @@ <h2 id="clojure.tools.deps/combine-aliases">combine-aliases</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L188">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L188">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.tools.deps/create-basis">create-basis</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (create-basis {:keys [dir root user project extra aliases], :as params})
<pre id="var-usage">Usage: (create-basis {:keys [dir root user project extra aliases args], :as params})
</pre>
<pre id="var-docstr">Create a basis from a set of deps sources and a set of aliases. By default, use
root, user, and project deps and no argmaps (essentially the same classpath you get by
Expand All @@ -325,8 +325,9 @@ <h2 id="clojure.tools.deps/create-basis">create-basis</h2>
Each dep source value can be :standard, a string path, a deps edn map, or nil.
Sources are merged in the order - :root, :user, :project, :extra.

Aliases refer to argmaps in the merged deps that will be supplied to the basis
subprocesses (tool, resolve-deps, make-classpath-map).
When resolving deps and forming the classpath, different steps need various
args. These are pulled from the 'argmap' which is a merged set of args
selected by the aliases and optionally a map of args.

Options:
:dir - directory root path, defaults to current directory
Expand All @@ -335,6 +336,7 @@ <h2 id="clojure.tools.deps/create-basis">create-basis</h2>
:project - dep source, default = :standard ("deps.edn")
:extra - dep source, default = nil
:aliases - coll of aliases, default = nil
:args - extra map of argmap args, merged after aliases

The following subprocess argmap args can be provided:
Key Subproc Description
Expand All @@ -355,7 +357,7 @@ <h2 id="clojure.tools.deps/create-basis">create-basis</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L790">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L790">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -368,7 +370,7 @@ <h2 id="clojure.tools.deps/create-edn-maps">create-edn-maps</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L775">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L775">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -383,7 +385,7 @@ <h2 id="clojure.tools.deps/find-edn-maps">find-edn-maps</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L120">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L120">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -397,7 +399,7 @@ <h2 id="clojure.tools.deps/find-latest-version">find-latest-version</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L883">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L883">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -409,7 +411,7 @@ <h2 id="clojure.tools.deps/join-classpath">join-classpath</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L613">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L613">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -422,7 +424,7 @@ <h2 id="clojure.tools.deps/lib-location">lib-location</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L196">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L196">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -447,7 +449,7 @@ <h2 id="clojure.tools.deps/make-classpath">make-classpath</h2>
Ret: string?</pre>

<span class="var-deprecated"><span id="content">Deprecated since tools.deps version 0.9.745</span><br /></span>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L618">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L618">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -472,7 +474,7 @@ <h2 id="clojure.tools.deps/make-classpath-map">make-classpath-map</h2>
Ret: map?</pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L594">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L594">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -484,7 +486,7 @@ <h2 id="clojure.tools.deps/merge-edns">merge-edns</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L143">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L143">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -506,7 +508,7 @@ <h2 id="clojure.tools.deps/prep-libs!">prep-libs!</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L679">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L680">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -518,7 +520,7 @@ <h2 id="clojure.tools.deps/print-tree">print-tree</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L522">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L522">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -542,7 +544,7 @@ <h2 id="clojure.tools.deps/resolve-added-libs">resolve-added-libs</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L852">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L852">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand Down Expand Up @@ -570,7 +572,7 @@ <h2 id="clojure.tools.deps/resolve-deps">resolve-deps</h2>
:clojure.tools.deps.specs/resolved-coord)</pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L479">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L479">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -583,7 +585,7 @@ <h2 id="clojure.tools.deps/root-deps">root-deps</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L101">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L101">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -596,20 +598,21 @@ <h2 id="clojure.tools.deps/slurp-deps">slurp-deps</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L94">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L94">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.tools.deps/tool">tool</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (tool project-edn tool-args)
</pre>
<pre id="var-docstr">Transform project edn for tool by applying tool args (keys = :paths, :deps) and
returning an updated project edn.</pre>
<pre id="var-docstr">Replaces project-edn :deps and :paths with tool :deps and :paths
and returns a new project-edn map.
(Also supports :replace-deps and :replace-paths as aliases.)</pre>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L632">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L632">Source</a>
</div><div id="var-entry">
<br />
<hr />
Expand All @@ -622,7 +625,7 @@ <h2 id="clojure.tools.deps/user-deps-path">user-deps-path</h2>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps/blob/ea5fdd63578abd4a30bdb7a794e67ea60a5cb0a2/src/main/clojure/clojure/tools/deps.clj#L108">Source</a>
<a id="var-source" href="https://github.com/clojure/tools.deps/blob/1540d7fdaf9f707aca5ee9c16199af280a772fd9/src/main/clojure/clojure/tools/deps.clj#L108">Source</a>
</div>
</div>

Expand Down

0 comments on commit d0e3d35

Please sign in to comment.