Documentation based on 8101f48

_sources/developer-guide.md.txt

@@ -24,11 +24,8 @@ As soon as you push to the `main` branch, GitHub Actions will take out these uni
 After locally building the documentation, open `docs/build/html/index.html` in your browser.
 
 ```bash
-. venv/bin/activate
-pip install -e .[docs]
-cd docs/
-sphinx-apidoc --force --output-dir source/ ../qunfold
-make html
+venv/bin/pip install -e .[docs]
+venv/bin/sphinx-build -M html docs/source docs/build
 ```
 
 As soon as you push to the `main` branch, GitHub Actions will build the documentation, push it to the `gh-pages` branch, and publish the result on GitHub Pages: [https://mirkobunse.github.io/qunfold](https://mirkobunse.github.io/qunfold)

_sources/index.md.txt

@@ -15,6 +15,7 @@ The Python package [qunfold](https://github.com/mirkobunse/qunfold) implements o
 ## Installation
 
 ```
+pip install --upgrade pip setuptools wheel
 pip install 'qunfold @ git+https://github.com/mirkobunse/qunfold'
 ```
 
@@ -32,14 +33,6 @@ To upgrade an existing installation of `qunfold`, run
 pip install --force-reinstall --no-deps 'qunfold @ git+https://github.com/mirkobunse/qunfold@main'
 ```
 
-### Troubleshooting
-
-Starting from `pip 23.1.2`, you have to install `setuptools` and `wheel` explicitly. If you receive a "NameError: name 'setuptools' is not defined", you need to execute the following command before installing `qunfold`.
-
-```
-pip install --upgrade pip setuptools wheel
-```
-
 
 ## Usage
 

developer-guide.html

@@ -114,11 +114,8 @@ <h3>Unit testing<a class="headerlink" href="#unit-testing" title="Link to this h
 <section id="documentation">
 <h3>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h3>
 <p>After locally building the documentation, open <code class="docutils literal notranslate"><span class="pre">docs/build/html/index.html</span></code> in your browser.</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>.<span class="w"> </span>venv/bin/activate
-pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="o">[</span>docs<span class="o">]</span>
-<span class="nb">cd</span><span class="w"> </span>docs/
-sphinx-apidoc<span class="w"> </span>--force<span class="w"> </span>--output-dir<span class="w"> </span>source/<span class="w"> </span>../qunfold
-make<span class="w"> </span>html
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>venv/bin/pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="o">[</span>docs<span class="o">]</span>
+venv/bin/sphinx-build<span class="w"> </span>-M<span class="w"> </span>html<span class="w"> </span>docs/source<span class="w"> </span>docs/build
 </pre></div>
 </div>
 <p>As soon as you push to the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch, GitHub Actions will build the documentation, push it to the <code class="docutils literal notranslate"><span class="pre">gh-pages</span></code> branch, and publish the result on GitHub Pages: <a class="reference external" href="https://mirkobunse.github.io/qunfold">https://mirkobunse.github.io/qunfold</a></p>

index.html

@@ -81,7 +81,8 @@ <h1>Quickstart<a class="headerlink" href="#quickstart" title="Link to this headi
 <p>The Python package <a class="reference external" href="https://github.com/mirkobunse/qunfold">qunfold</a> implements our unified framework of algorithms for quantification and unfolding. It is designed for enabling the composition of novel methods from existing and easily customized loss functions and data representations. Moreover, this package leverages a powerful optimization back-end to yield state-of-the-art performances for all compositions.</p>
 <section id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h2>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="s1">&#39;qunfold @ git+https://github.com/mirkobunse/qunfold&#39;</span>
+<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">upgrade</span> <span class="n">pip</span> <span class="n">setuptools</span> <span class="n">wheel</span>
+<span class="n">pip</span> <span class="n">install</span> <span class="s1">&#39;qunfold @ git+https://github.com/mirkobunse/qunfold&#39;</span>
 </pre></div>
 </div>
 <p>Moreover, you will need a <a class="reference external" href="https://jax.readthedocs.io/">JAX</a> backend. Typically, the CPU backend will be ideal:</p>
@@ -95,13 +96,6 @@ <h3>Upgrading<a class="headerlink" href="#upgrading" title="Link to this heading
 </pre></div>
 </div>
 </section>
-<section id="troubleshooting">
-<h3>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading"></a></h3>
-<p>Starting from <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">23.1.2</span></code>, you have to install <code class="docutils literal notranslate"><span class="pre">setuptools</span></code> and <code class="docutils literal notranslate"><span class="pre">wheel</span></code> explicitly. If you receive a “NameError: name ‘setuptools’ is not defined”, you need to execute the following command before installing <code class="docutils literal notranslate"><span class="pre">qunfold</span></code>.</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">upgrade</span> <span class="n">pip</span> <span class="n">setuptools</span> <span class="n">wheel</span>
-</pre></div>
-</div>
-</section>
 </section>
 <section id="usage">
 <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h2>