160 lines
8.5 KiB
HTML
160 lines
8.5 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>cpl publish — Common Python Library documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="cpl remove" href="cpl_cli.remove.html" />
|
||
<link rel="prev" title="cpl new" href="cpl_cli.new.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
Common Python Library
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI reference</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.overview.html">CLI Overview and Command Reference</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.add.html">cpl add</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.build.html">cpl build</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.generate.html">cpl generate</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.help.html">cpl help</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.install.html">cpl install</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.new.html">cpl new</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl publish</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#contents">Contents</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.remove.html">cpl remove</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.run.html">cpl run</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.start.html">cpl start</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.uninstall.html">cpl uninstall</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.update.html">cpl update</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cpl_cli.version.html">cpl version</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Common Python Library</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="cpl_cli.html">CLI reference</a></li>
|
||
<li class="breadcrumb-item active">cpl publish</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/cpl_cli.publish.md.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="cpl-publish">
|
||
<h1>cpl publish<a class="headerlink" href="#cpl-publish" title="Permalink to this heading"></a></h1>
|
||
<section id="contents">
|
||
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading"></a></h2>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="cpl_discord.container.html#cpl_discord.container.guild.Guild.description" title="cpl_discord.container.guild.Guild.description"><span class="xref myst py py-attr">Description</span></a></p></li>
|
||
</ul>
|
||
<!-- - [Arguments](#arguments) -->
|
||
<p>Prepares files for publish into an output directory named dist/ at the given output path and executes <code class="docutils literal notranslate"><span class="pre">setup.py</span></code>.</p>
|
||
<p>cpl <strong>publish</strong> <br>
|
||
cpl <strong>p</strong> <br>
|
||
cpl <strong>P</strong></p>
|
||
</section>
|
||
<section id="description">
|
||
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
||
<p>The command can be used to publish a project of type “console” or “library”.</p>
|
||
<p>The publish command builds the source files and then creates an <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> with data from <code class="docutils literal notranslate"><span class="pre">cpl_core.json</span></code>.
|
||
The command executes the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> and removes all source files with the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> from the ‘publish/’ directory.</p>
|
||
<p>Generated files of <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> are in the ‘publish/setup/’ directory.</p>
|
||
<!-- ## Arguments
|
||
|
||
| Argument | Description | Value type |
|
||
| ------------- |:-------------:|:----------------:|
|
||
| ```<project>``` | The name of the project to build. Can be an console or a library. | ```str``` -->
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="cpl_cli.new.html" class="btn btn-neutral float-left" title="cpl new" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="cpl_cli.remove.html" class="btn btn-neutral float-right" title="cpl remove" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2021 - 2023, Sven Heidemann.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |