2021-05-17 18:32:09 +02:00
<!DOCTYPE html>
< html class = "writer-html5" lang = "en" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > cpl publish — Common Python Library documentation< / title >
2021-11-02 17:23:42 +01:00
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
2021-05-17 18:32:09 +02:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2021-11-02 17:23:42 +01:00
< script data-url_root = "./" id = "documentation_options" src = "_static/documentation_options.js" > < / script >
2021-05-17 18:32:09 +02:00
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
2021-11-02 17:23:42 +01:00
< script src = "_static/js/theme.js" > < / script >
2021-05-17 18:32:09 +02:00
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "cpl remove" href = "cli.remove.html" / >
< link rel = "prev" title = "cpl new" href = "cli.new.html" / >
< / head >
2021-11-02 17:23:42 +01:00
< body class = "wy-body-for-nav" >
2021-05-17 18:32:09 +02:00
< 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" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
2021-11-02 17:23:42 +01:00
< / div > < div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "Navigation menu" >
2021-05-17 18:32:09 +02:00
< 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 current" > < a class = "reference internal" href = "cpl_cli.html" > CLI Reference< / a > < ul class = "current" >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.overview.html" > CLI Overview and Command Reference< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.add.html" > cpl add< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.build.html" > cpl build< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.generate.html" > cpl generate< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.help.html" > cpl help< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.install.html" > cpl install< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "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 = "cli.remove.html" > cpl remove< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.start.html" > cpl start< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.uninstall.html" > cpl uninstall< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.update.html" > cpl update< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "cli.version.html" > cpl version< / a > < / li >
< / ul >
< / li >
2021-11-01 20:43:25 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_core.html" > API Reference< / a > < / li >
2021-11-01 21:17:56 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cpl_query.html" > Query Reference< / a > < / li >
2021-05-17 18:32:09 +02:00
< / ul >
< / div >
< / div >
< / nav >
2021-11-02 17:23:42 +01:00
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" > < nav class = "wy-nav-top" aria-label = "Mobile navigation menu" >
2021-05-17 18:32:09 +02:00
< 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" >
2021-11-02 17:23:42 +01:00
< div role = "navigation" aria-label = "Page navigation" >
2021-05-17 18:32:09 +02:00
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" class = "icon icon-home" > < / a > » < / li >
< li > < a href = "cpl_cli.html" > CLI Reference< / a > » < / li >
< li > cpl publish< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/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" >
2021-11-02 17:23:42 +01:00
< div class = "tex2jax_ignore mathjax_ignore section" id = "cpl-publish" >
< h1 > cpl publish< a class = "headerlink" href = "#cpl-publish" title = "Permalink to this headline" > < / a > < / h1 >
2021-05-17 18:32:09 +02:00
< div class = "section" id = "contents" >
2021-11-02 17:23:42 +01:00
< h2 > Contents< a class = "headerlink" href = "#contents" title = "Permalink to this headline" > < / a > < / h2 >
2021-05-17 18:32:09 +02:00
< ul class = "simple" >
< li > < p > < a class = "reference external" href = "#description" > Description< / 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 >
< / div >
< div class = "section" id = "description" >
2021-11-02 17:23:42 +01:00
< h2 > Description< a class = "headerlink" href = "#description" title = "Permalink to this headline" > < / a > < / h2 >
2021-05-17 18:32:09 +02:00
< p > The command can be used to publish a project of type “console” or “library”.< / p >
2021-11-01 20:43:25 +01:00
< 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 > .
2021-05-17 18:32:09 +02:00
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``` -->< / div >
< / div >
< / div >
< / div >
2021-11-02 17:23:42 +01:00
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
2021-05-17 18:32:09 +02:00
< a href = "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 >
2021-11-02 17:23:42 +01:00
< a href = "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 >
2021-05-17 18:32:09 +02:00
< / div >
< hr / >
< div role = "contentinfo" >
2021-11-02 17:23:42 +01:00
< p > © Copyright 2021, Sven Heidemann.< / p >
2021-05-17 18:32:09 +02:00
< / div >
2021-11-02 17:23:42 +01:00
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
2021-05-17 18:32:09 +02:00
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
2021-11-02 17:23:42 +01:00
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2021-05-17 18:32:09 +02:00
< / footer >
< / div >
< / div >
< / section >
< / div >
2021-11-02 17:23:42 +01:00
< script >
2021-05-17 18:32:09 +02:00
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
2021-11-02 17:23:42 +01:00
< / script >
2021-05-17 18:32:09 +02:00
< / body >
< / html >