deploy: e0b0064

_sources/index.md

@@ -41,6 +41,69 @@
 
 ```
 
+## Installation
+
+To install the Cobots 2024 package, use the following command:
+
+```
+pip install cobots2024
+```
+
+Or
+
+```
+pip install --user cobots2024
+```
+
+The `--user` flag is optional and can be used to install the package in the user's home directory instead of the system-wide location.
+
+## Usage
+
+To use the Cobots 2024 CLI, run the following command:
+
+```
+cobots2024 [OPTIONS]
+```
+
+If no option is provided, the website of the book will open in the default web browser.
+
+### Options
+
+The following options are available:
+
+- `--version`: Show the version of the package and exit.
+- `-b`, `--build`: Build the book.
+- `-l`, `--local`: Open the locally built HTML version of the book in the browser.
+- `--help`: Show the help message and exit.
+
+### Examples
+
+1. To build the book, use the following command:
+
+   ```
+   cobots2024 --build
+   ```
+
+   This will trigger the build process for the book.
+
+2. To open the locally built HTML version of the book in the browser, use the following command:
+
+   ```
+   cobots2024 --local
+   ```
+
+   This will open the book's HTML file in your default web browser.
+
+3. To view the version of the package, use the following command:
+
+   ```
+   cobots2024 --version
+   ```
+
+   This will display the version number of the Cobots 2024 package.
+
+For more information and additional options, run `cobots2024 --help` to see the help message.
+
 ## Contributors
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

index.html

@@ -441,6 +441,12 @@ <h2> Contents </h2>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#table-of-contents">Table of Contents</a><ul class="nav section-nav flex-column">
 </ul>
 </li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#usage">Usage</a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#options">Options</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#examples">Examples</a></li>
+</ul>
+</li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contributors">Contributors</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#changelog">Changelog</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contributing">Contributing</a></li>
@@ -500,6 +506,60 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link
 </ul>
 </div>
 </section>
+<section id="installation">
+<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">#</a></h2>
+<p>To install the Cobots 2024 package, use the following command:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">cobots2024</span>
+</pre></div>
+</div>
+<p>Or</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">user</span> <span class="n">cobots2024</span>
+</pre></div>
+</div>
+<p>The <code class="docutils literal notranslate"><span class="pre">--user</span></code> flag is optional and can be used to install the package in the user’s home directory instead of the system-wide location.</p>
+</section>
+<section id="usage">
+<h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">#</a></h2>
+<p>To use the Cobots 2024 CLI, run the following command:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cobots2024</span> <span class="p">[</span><span class="n">OPTIONS</span><span class="p">]</span>
+</pre></div>
+</div>
+<p>If no option is provided, the website of the book will open in the default web browser.</p>
+<section id="options">
+<h3>Options<a class="headerlink" href="#options" title="Link to this heading">#</a></h3>
+<p>The following options are available:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">--version</span></code>: Show the version of the package and exit.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-b</span></code>, <code class="docutils literal notranslate"><span class="pre">--build</span></code>: Build the book.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">-l</span></code>, <code class="docutils literal notranslate"><span class="pre">--local</span></code>: Open the locally built HTML version of the book in the browser.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">--help</span></code>: Show the help message and exit.</p></li>
+</ul>
+</section>
+<section id="examples">
+<h3>Examples<a class="headerlink" href="#examples" title="Link to this heading">#</a></h3>
+<ol class="arabic">
+<li><p>To build the book, use the following command:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cobots2024</span> <span class="o">--</span><span class="n">build</span>
+</pre></div>
+</div>
+<p>This will trigger the build process for the book.</p>
+</li>
+<li><p>To open the locally built HTML version of the book in the browser, use the following command:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cobots2024</span> <span class="o">--</span><span class="n">local</span>
+</pre></div>
+</div>
+<p>This will open the book’s HTML file in your default web browser.</p>
+</li>
+<li><p>To view the version of the package, use the following command:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cobots2024</span> <span class="o">--</span><span class="n">version</span>
+</pre></div>
+</div>
+<p>This will display the version number of the Cobots 2024 package.</p>
+</li>
+</ol>
+<p>For more information and additional options, run <code class="docutils literal notranslate"><span class="pre">cobots2024</span> <span class="pre">--help</span></code> to see the help message.</p>
+</section>
+</section>
 <section id="contributors">
 <h2>Contributors<a class="headerlink" href="#contributors" title="Link to this heading">#</a></h2>
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
@@ -581,6 +641,12 @@ <h2>License<a class="headerlink" href="#license" title="Link to this heading">#<
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#table-of-contents">Table of Contents</a><ul class="nav section-nav flex-column">
 </ul>
 </li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#usage">Usage</a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#options">Options</a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#examples">Examples</a></li>
+</ul>
+</li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contributors">Contributors</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#changelog">Changelog</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contributing">Contributing</a></li>