Skip to content

Commit fb9010e

Browse files
MaxusmustiMaxusmusti
authored
Adding docstrings, cleaning up formatting, and adding documentation site (#40)
* Adding docstrings and descs, cleaning formatting * Further reformatting * Added documentation site
1 parent 9b2acf1 commit fb9010e

File tree

14 files changed

+3494
-159
lines changed

14 files changed

+3494
-159
lines changed

‎docs/codeflare_sdk/cluster/cluster.html‎

Lines changed: 873 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/codeflare_sdk/cluster/config.html‎

Lines changed: 234 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/codeflare_sdk/cluster/index.html‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.10.0" />
7+
<title>codeflare_sdk.cluster API documentation</title>
8+
<meta name="description" content="" />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Module <code>codeflare_sdk.cluster</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
</section>
26+
<section>
27+
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
28+
<dl>
29+
<dt><code class="name"><a title="codeflare_sdk.cluster.cluster" href="cluster.html">codeflare_sdk.cluster.cluster</a></code></dt>
30+
<dd>
31+
<div class="desc"><p>The cluster sub-module contains the definition of the Cluster object, which represents
32+
the resources requested by the user. It also contains functions …</p></div>
33+
</dd>
34+
<dt><code class="name"><a title="codeflare_sdk.cluster.config" href="config.html">codeflare_sdk.cluster.config</a></code></dt>
35+
<dd>
36+
<div class="desc"><p>The config sub-module contains the definition of the ClusterConfiguration dataclass,
37+
which is used to specify resource requirements and other details …</p></div>
38+
</dd>
39+
<dt><code class="name"><a title="codeflare_sdk.cluster.model" href="model.html">codeflare_sdk.cluster.model</a></code></dt>
40+
<dd>
41+
<div class="desc"><p>The model sub-module defines Enums containing information for Ray cluster
42+
states and AppWrapper states, and CodeFlare cluster states, as well as
43+
…</p></div>
44+
</dd>
45+
</dl>
46+
</section>
47+
<section>
48+
</section>
49+
<section>
50+
</section>
51+
<section>
52+
</section>
53+
</article>
54+
<nav id="sidebar">
55+
<h1>Index</h1>
56+
<div class="toc">
57+
<ul></ul>
58+
</div>
59+
<ul id="index">
60+
<li><h3>Super-module</h3>
61+
<ul>
62+
<li><code><a title="codeflare_sdk" href="../index.html">codeflare_sdk</a></code></li>
63+
</ul>
64+
</li>
65+
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
66+
<ul>
67+
<li><code><a title="codeflare_sdk.cluster.cluster" href="cluster.html">codeflare_sdk.cluster.cluster</a></code></li>
68+
<li><code><a title="codeflare_sdk.cluster.config" href="config.html">codeflare_sdk.cluster.config</a></code></li>
69+
<li><code><a title="codeflare_sdk.cluster.model" href="model.html">codeflare_sdk.cluster.model</a></code></li>
70+
</ul>
71+
</li>
72+
</ul>
73+
</nav>
74+
</main>
75+
<footer id="footer">
76+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
77+
</footer>
78+
</body>
79+
</html>

0 commit comments

Comments
 (0)