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 Aug 22, 2023
1 parent 6845a0c commit 41fb95c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 76 deletions.
15 changes: 6 additions & 9 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.graph 0.2.31-SNAPSHOT API documentation</title>
<title>Index - tools.deps.graph 1.1.77-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.g
<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.graph</span> <span id="version">0.2.31-SNAPSHOT</span> API</span><br />
<span class="toc-header"><span id="project-name">tools.deps.graph</span> <span id="version">1.1.77-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.g
<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.graph</span> <span id="header-version">0.2.31-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.graph</span> <span id="header-version">1.1.77-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.graph</span>.

Expand Down Expand Up @@ -130,8 +130,7 @@ <h2 id="L"><span id="section-head">L</span></h2>
</div><div id="index-body">
<h2 id="M"><span id="section-head">M</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.deps.graph/-main">-main</a><span id="line-content"> function graph Create deps graphs. By default, reads deps.edn in ...
</span></span>

</pre>
</div><div id="index-body">
<h2 id="N"><span id="section-head">N</span></h2>
Expand All @@ -146,9 +145,7 @@ <h2 id="O"><span id="section-head">O</span></h2>
</div><div id="index-body">
<h2 id="P"><span id="section-head">P</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.deps.graph/parse-opts">parse-opts</a><span id="line-content"> function graph Parse the command line opts to make-classpath.
</span></span><span id="section-content"> <a href="index.html#clojure.tools.deps.graph/parse-syms">parse-syms</a><span id="line-content"> function graph Parses a concatenated string of libs into a collec...
</span></span>

</pre>
</div><div id="index-body">
<h2 id="Q"><span id="section-head">Q</span></h2>
Expand Down Expand Up @@ -215,7 +212,7 @@ <h2 id="Other"><span id="section-head">Other</span></h2>
</div>
</div>
<div id="foot">
<div id="copyright" style="text-align: center;">Copyright 2007-2019 by Rich Hickey and the various contributors</div>
<div id="copyright" style="text-align: center;">Copyright 2007-2023 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo &amp; site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
Expand Down
73 changes: 6 additions & 67 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>graph - tools.deps.graph 0.2.31-SNAPSHOT API documentation</title>
<title>graph - tools.deps.graph 1.1.77-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.g
<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.graph</span> <span id="version">0.2.31-SNAPSHOT</span> API</span><br />
<span class="toc-header"><span id="project-name">tools.deps.graph</span> <span id="version">1.1.77-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 @@ -52,25 +52,16 @@ <h1 class="nopad">Table of Contents</h1>
<a style="margin-top: 3px;" href="#"></a>

</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#var-section">Vars and Functions</a>
<div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.tools.deps.graph/-main" class="toc-entry-anchor">-main</a>

</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.tools.deps.graph/parse-opts" class="toc-entry-anchor">parse-opts</a>

</div><div class="toc-entry" style="margin-left: 1em;">
<a href="#clojure.tools.deps.graph/parse-syms" class="toc-entry-anchor">parse-syms</a>

</div>
<a style="margin-top: 3px;" href="#"></a>

</div><div class="toc-section" style="margin-left: 1em;">
<a style="margin-top: 3px;" href="#"></a>

</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="graph">graph</span>
- <span id="header-project">tools.deps.graph</span> <span id="header-version">0.2.31-SNAPSHOT</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
- <span id="header-project">tools.deps.graph</span> <span id="header-version">1.1.77-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.graph</span>
Expand All @@ -84,59 +75,7 @@ <h2>Overview</h2>



<div id="var-section">
<p></p>
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.tools.deps.graph/-main">-main</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (-main &amp; args)
</pre>
<pre id="var-docstr">Create deps graphs. By default, reads deps.edn in current directory, creates deps graph,
and shows using a viewer. Use ctrl-c to exit.

Options:
-d DEPSFILE - deps.edn file to read, default=deps.edn
-t - Trace mode, will output one image per expansion step
-f TRACEFILE - Trace file mode - read trace file, don't use deps.edn file
-o FILE - Output file, in trace mode required and will create N images
-a - Concatenated alias names when reading deps file
--trace-omit - Comma-delimited list of libs to skip in trace images
--size - Include jar size in dep graph nodes</pre>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps.graph/blob/e0ffcfa30c55c5af48034ba1cdae9771a51a7ce0/src/main/clojure/clojure/tools/deps/graph.clj#L216">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.tools.deps.graph/parse-opts">parse-opts</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (parse-opts args)
</pre>
<pre id="var-docstr">Parse the command line opts to make-classpath</pre>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps.graph/blob/e0ffcfa30c55c5af48034ba1cdae9771a51a7ce0/src/main/clojure/clojure/tools/deps/graph.clj#L63">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.tools.deps.graph/parse-syms">parse-syms</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (parse-syms s)
</pre>
<pre id="var-docstr">Parses a concatenated string of libs into a collection of symbols
Ex: (parse-libs "org.clojure/clojure,org.clojure/test.check")
Returns: [org.clojure/clojure org.clojure/test.check]</pre>
<pre id="var-specs"></pre>


<a id="var-source" href="https://github.com/clojure/tools.deps.graph/blob/e0ffcfa30c55c5af48034ba1cdae9771a51a7ce0/src/main/clojure/clojure/tools/deps/graph.clj#L31">Source</a>
</div>
</div>


</div>
Expand All @@ -145,7 +84,7 @@ <h2 id="clojure.tools.deps.graph/parse-syms">parse-syms</h2>
</div>
</div>
<div id="foot">
<div id="copyright" style="text-align: center;">Copyright 2007-2019 by Rich Hickey and the various contributors</div>
<div id="copyright" style="text-align: center;">Copyright 2007-2023 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo &amp; site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
Expand Down

0 comments on commit 41fb95c

Please sign in to comment.