Skip to content

Commit

Permalink
Add new docs, final updates
Browse files Browse the repository at this point in the history
  • Loading branch information
biosafetylvl5 committed Oct 23, 2024
1 parent fd11189 commit b2a354c
Show file tree
Hide file tree
Showing 61 changed files with 6,487 additions and 994 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,5 @@ cython_debug/

.vscode/settings.json
.brassy

.buildinfo
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 012e053f98c36652452d36c572f46ce6
config: a7850f5afc0219d7d5902826f4f7f68c
tags: 645f666f9bcd5a90fca523b33c5a78b7
353 changes: 353 additions & 0 deletions docs/_modules/brassy/actions/build_release_notes.html

Large diffs are not rendered by default.

139 changes: 139 additions & 0 deletions docs/_modules/brassy/actions/init.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<!DOCTYPE html>

<html lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>brassy.actions.init &#8212; brassy 0.0.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="../../../_static/basic.css?v=c058f7c8" />
<link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=27fed22d" />
<script src="../../../_static/documentation_options.js?v=47de8214"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />

<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />





</head><body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<h1>Source code for brassy.actions.init</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">brassy</span>
<span class="kn">from</span> <span class="nn">brassy.brassy</span> <span class="kn">import</span> <span class="n">Settings</span>


<div class="viewcode-block" id="init">
<a class="viewcode-back" href="../../../api.html#brassy.actions.init.init">[docs]</a>
<span class="k">def</span> <span class="nf">init</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Initialize configuration files for the application.</span>

<span class="sd"> This function creates site and user configuration files, and optionally</span>
<span class="sd"> a project configuration file based on user input.</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> None</span>

<span class="sd"> Examples</span>
<span class="sd"> --------</span>
<span class="sd"> &gt;&gt;&gt; init()</span>
<span class="sd"> Do you want to create a project config file? [y/N]: y</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">Settings</span><span class="o">.</span><span class="n">enable_experimental_features</span><span class="p">:</span>
<span class="n">conf_files</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">brassy</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">settings_manager</span><span class="o">.</span><span class="n">get_site_config_file_path</span><span class="p">(</span><span class="s2">&quot;brassy&quot;</span><span class="p">),</span>
<span class="n">brassy</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">settings_manager</span><span class="o">.</span><span class="n">get_user_config_file_path</span><span class="p">(</span><span class="s2">&quot;brassy&quot;</span><span class="p">),</span>
<span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">conf_files</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">conf_file</span> <span class="ow">in</span> <span class="n">conf_files</span><span class="p">:</span>
<span class="n">brassy</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">settings_manager</span><span class="o">.</span><span class="n">create_config_file</span><span class="p">(</span><span class="n">conf_file</span><span class="p">)</span>
<span class="k">if</span> <span class="n">brassy</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">boolean_prompt</span><span class="p">(</span>
<span class="s2">&quot;Do you want to create a project config file?&quot;</span>
<span class="p">):</span>
<span class="n">brassy</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">settings_manager</span><span class="o">.</span><span class="n">create_config_file</span><span class="p">(</span>
<span class="n">brassy</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">settings_manager</span><span class="o">.</span><span class="n">get_project_config_file_path</span><span class="p">(</span><span class="s2">&quot;brassy&quot;</span><span class="p">)</span>
<span class="p">)</span></div>

</pre></div>

</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../../index.html">brassy</a></h1>









<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../using-brassy.html">Using Brassy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../releases/index.html">Release Notes</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../../index.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;.

|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>

</div>




</body>
</html>
Loading

0 comments on commit b2a354c

Please sign in to comment.