Updated docs
This commit is contained in:
22
docs/build/html/setup.html
vendored
22
docs/build/html/setup.html
vendored
@@ -60,7 +60,7 @@
|
||||
<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="cpl_cli.html">CLI reference</a></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_discord.html">cpl_discord package</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>
|
||||
@@ -120,7 +120,7 @@
|
||||
<section id="install-the-package">
|
||||
<h2>Install the package<a class="headerlink" href="#install-the-package" title="Permalink to this heading"></a></h2>
|
||||
<p>To install the package, open a terminal window and run the following command:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install cpl-core --extra-index-url https://pip.sh-edraft.de
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>cpl-core<span class="w"> </span>--extra-index-url<span class="w"> </span>https://pip.sh-edraft.de
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -128,14 +128,14 @@
|
||||
<h2>Install the CLI<a class="headerlink" href="#install-the-cli" title="Permalink to this heading"></a></h2>
|
||||
<p>You use the CPL CLI to create projects, generate application and library code. You also use the CLI to build and publish your python packages.</p>
|
||||
<p>To install the CLI, open a terminal window and run the following command:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install cpl-cli --extra-index-url https://pip.sh-edraft.de
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>cpl-cli<span class="w"> </span>--extra-index-url<span class="w"> </span>https://pip.sh-edraft.de
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="install-the-query">
|
||||
<h2>Install the query<a class="headerlink" href="#install-the-query" title="Permalink to this heading"></a></h2>
|
||||
<p>To install the package, open a terminal window and run the following command:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install cpl-query --extra-index-url https://pip.sh-edraft.de
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>cpl-query<span class="w"> </span>--extra-index-url<span class="w"> </span>https://pip.sh-edraft.de
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -144,7 +144,7 @@
|
||||
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Run the CLI command <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span> <span class="pre">console</span></code> and provide the name my-app, as shown here:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console my-app
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl<span class="w"> </span>new<span class="w"> </span>console<span class="w"> </span>my-app
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
@@ -157,7 +157,7 @@
|
||||
<p>You develop apps and packages in the context of an CPL project which is defined in an cpl_core.json.</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Run the CLI command <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span> <span class="pre">library</span></code> and provide the name my-lib, as shown here:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new library my-lib
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl<span class="w"> </span>new<span class="w"> </span>library<span class="w"> </span>my-lib
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
@@ -171,27 +171,27 @@
|
||||
<ol class="arabic">
|
||||
<li><p>Open a terminal window</p></li>
|
||||
<li><p>To navigate to your project workspace, run the following command:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> /path/to/project/name
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>/path/to/project/name
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>To run the app run:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl start
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl<span class="w"> </span>start
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">start</span></code> command launches the server, watches your source files, and restarts the app as you make chnages to thoses source files.</p>
|
||||
<p>If your installation and setup was successful, you should see a output similar to the following:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Hello World
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>Hello<span class="w"> </span>World
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="what-s-next">
|
||||
<h2>What’s next<a class="headerlink" href="#what-s-next" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>To learn more about the CPL CLI, see the <a class="reference internal" href="cli.overview.html"><span class="doc std std-doc">CLI Overview</span></a></p></li>
|
||||
<li><p>Fore more informations about the Pyhton files generated by <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span></code>, see <a class="reference internal" href="cli.new.html"><span class="doc std std-doc">New Command</span></a></p></li>
|
||||
<li><p>To learn more about the CPL CLI, see the <a class="reference internal" href="cpl_cli.overview.html"><span class="doc std std-doc">CLI Overview</span></a></p></li>
|
||||
<li><p>Fore more informations about the Pyhton files generated by <code class="docutils literal notranslate"><span class="pre">cpl</span> <span class="pre">new</span></code>, see <a class="reference internal" href="cpl_cli.new.html"><span class="doc std std-doc">New Command</span></a></p></li>
|
||||
</ul>
|
||||
<!-- LINKS -->
|
||||
</section>
|
||||
|
Reference in New Issue
Block a user