Source moved to docs

Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = jMetalPy
-SOURCEDIR     = source
+SOURCEDIR     = docs/source
 BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".

README.md

@@ -1,4 +1,4 @@
-![jMetalPy](source/jmetalpy.png)
+![jMetalPy](docs/source/jmetalpy.png)
 
 [![Build Status](https://img.shields.io/travis/jMetal/jMetalPy/master.svg?style=flat-square)](https://travis-ci.org/jMetal/jMetalPy)
 [![Documentation](https://img.shields.io/badge/docs-online-success?style=flat-square)](https://jmetal.github.io/jMetalPy/index.html)
@@ -42,7 +42,7 @@ pip install "jmetalpy[core]"
 Other supported commands are listed next:
 
 ```console
-pip install "jmetalpy[doc]"  # Install requirements for building docs
+pip install "jmetalpy[docs]"  # Install requirements for building docs
 pip install "jmetalpy[distributed]"  # Install requirements for parallel/distributed computing
 pip install "jmetalpy[complete]"  # Install all requirements
 ```
@@ -96,7 +96,7 @@ plot_front = Plot(title='Pareto front approximation', axis_labels=['x', 'y'])
 plot_front.plot(front, label='NSGAII-ZDT1', filename='NSGAII-ZDT1', format='png')
 ```
 
-<img src=source/_static/NSGAII-ZDT1.png width=450 alt="Pareto front approximation">
+<img src=docs/source/_static/NSGAII-ZDT1.png width=450 alt="Pareto front approximation">
 
 ## Features
 The current release of jMetalPy (v1.5.3) contains the following components:
@@ -111,9 +111,9 @@ The current release of jMetalPy (v1.5.3) contains the following components:
 * Experiment class for performing studies either alone or alongside [jMetal](https://github.com/jMetal/jMetal).
 * Pairwise and multiple hypothesis testing for statistical analysis, including several frequentist and Bayesian testing methods, critical distance plots and posterior diagrams.
 
-| ![Scatter plot 2D](source/_static/2D.gif) | ![Scatter plot 3D](source/_static/3D.gif) |
+| ![Scatter plot 2D](docs/source/_static/2D.gif) | ![Scatter plot 3D](docs/source/_static/3D.gif) |
 |-------------- | ----------------  |
-| ![Parallel coordinates](source/_static/p-c.gif) | ![Interactive chord plot](source/_static/chordplot.gif) |
+| ![Parallel coordinates](docs/source/_static/p-c.gif) | ![Interactive chord plot](docs/source/_static/chordplot.gif) |
 
 ## License
 This project is licensed under the terms of the MIT - see the [LICENSE](LICENSE) file for details.

docs/_modules/jmetal/lab/visualization/plotting.html

@@ -227,8 +227,9 @@ <h1>Source code for jmetal.lab.visualization.plotting</h1><div class="highlight"
 
         <span class="k">if</span> <span class="n">filename</span><span class="p">:</span>
             <span class="n">plt</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">filename</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span> <span class="o">+</span> <span class="nb">format</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="nb">format</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">200</span><span class="p">)</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 
-        <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
         <span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="n">fig</span><span class="o">=</span><span class="n">fig</span><span class="p">)</span></div>
 
 <div class="viewcode-block" id="Plot.three_dim"><a class="viewcode-back" href="../../../../tutorials/visualization.html#jmetal.lab.visualization.plotting.Plot.three_dim">[docs]</a>    <span class="k">def</span> <span class="nf">three_dim</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fronts</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">list</span><span class="p">],</span> <span class="n">labels</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="nb">format</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;eps&#39;</span><span class="p">):</span>
@@ -267,8 +268,9 @@ <h1>Source code for jmetal.lab.visualization.plotting</h1><div class="highlight"
 
         <span class="k">if</span> <span class="n">filename</span><span class="p">:</span>
             <span class="n">plt</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">filename</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span> <span class="o">+</span> <span class="nb">format</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="nb">format</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">1000</span><span class="p">)</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 
-        <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
         <span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="n">fig</span><span class="o">=</span><span class="n">fig</span><span class="p">)</span></div>
 
 <div class="viewcode-block" id="Plot.pcoords"><a class="viewcode-back" href="../../../../tutorials/visualization.html#jmetal.lab.visualization.plotting.Plot.pcoords">[docs]</a>    <span class="k">def</span> <span class="nf">pcoords</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fronts</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">list</span><span class="p">],</span> <span class="n">normalize</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="nb">format</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;eps&#39;</span><span class="p">):</span>
@@ -300,8 +302,9 @@ <h1>Source code for jmetal.lab.visualization.plotting</h1><div class="highlight"
 
         <span class="k">if</span> <span class="n">filename</span><span class="p">:</span>
             <span class="n">plt</span><span class="o">.</span><span class="n">savefig</span><span class="p">(</span><span class="n">filename</span> <span class="o">+</span> <span class="s1">&#39;.&#39;</span> <span class="o">+</span> <span class="nb">format</span><span class="p">,</span> <span class="nb">format</span><span class="o">=</span><span class="nb">format</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">1000</span><span class="p">)</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
 
-        <span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
         <span class="n">plt</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="n">fig</span><span class="o">=</span><span class="n">fig</span><span class="p">)</span></div></div>
 </pre></div>
 

docs/_modules/jmetal/problem/multiobjective/lircmop.html

@@ -271,7 +271,7 @@ <h1>Source code for jmetal.problem.multiobjective.lircmop</h1><div class="highli
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">number_of_variables</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">30</span><span class="p">):</span>
-        <span class="nb">super</span><span class="p">(</span><span class="n">LIRCMOP1</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
+        <span class="nb">super</span><span class="p">(</span><span class="n">LIRCMOP5</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">number_of_variables</span> <span class="o">=</span> <span class="n">number_of_variables</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">number_of_objectives</span> <span class="o">=</span> <span class="mi">2</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">number_of_constraints</span> <span class="o">=</span> <span class="mi">2</span>

docs/_sources/index.rst.txt

@@ -31,8 +31,15 @@ Via pip:
 .. code-block:: console
 
     $ pip install jmetalpy
-    $ pip install "jmetalpy[core]"  # Install core components of the framework
-    $ pip install "jmetalpy[complete]"  # Install also dependencies for distributed computing
+
+.. note:: Alternatively, you can use one of these instead:
+
+    .. code-block:: console
+
+        $ pip install "jmetalpy[core]"  # Install core components of the framework
+        $ pip install "jmetalpy[docs]"  # Install requirements for building docs
+        $ pip install "jmetalpy[distributed]"  # Install requirements for parallel/distributed computing
+        $ pip install "jmetalpy[complete]"  # Install all dependencies (equivalent to `pip install jmetalpy`)
 
 Via source code:
 
@@ -51,7 +58,7 @@ The current release of jMetalPy (v1.5.3) contains the following components:
 * Encodings: real, binary, permutations.
 * Operators: selection (binary tournament, ranking and crowding distance, random, nary random, best solution), crossover (single-point, SBX), mutation (bit-blip, polynomial, uniform, random).
 * Quality indicators: hypervolume, additive epsilon, GD, IGD.
-* Pareto front plotting for problems with two or more objectives (as scatter plot/parallel coordinates/chordplot) in real-time, static or interactive.
+* Pareto front approximation plotting in real-time, static or interactive.
 * Experiment class for performing studies either alone or alongside jMetal.
 * Pairwise and multiple hypothesis testing for statistical analysis, including several frequentist and Bayesian testing methods, critical distance plots and posterior diagrams.
 

docs/index.html

@@ -164,10 +164,18 @@ <h2>Content<a class="headerlink" href="#content" title="Permalink to this headli
 <h2>Installation steps<a class="headerlink" href="#installation-steps" title="Permalink to this headline">¶</a></h2>
 <p>Via pip:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> pip install jmetalpy
-<span class="gp">$</span> pip install <span class="s2">&quot;jmetalpy[core]&quot;</span>  <span class="c1"># Install core components of the framework</span>
-<span class="gp">$</span> pip install <span class="s2">&quot;jmetalpy[complete]&quot;</span>  <span class="c1"># Install also dependencies for distributed computing</span>
 </pre></div>
 </div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Alternatively, you can use one of these instead:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> pip install <span class="s2">&quot;jmetalpy[core]&quot;</span>  <span class="c1"># Install core components of the framework</span>
+<span class="gp">$</span> pip install <span class="s2">&quot;jmetalpy[docs]&quot;</span>  <span class="c1"># Install requirements for building docs</span>
+<span class="gp">$</span> pip install <span class="s2">&quot;jmetalpy[distributed]&quot;</span>  <span class="c1"># Install requirements for parallel/distributed computing</span>
+<span class="gp">$</span> pip install <span class="s2">&quot;jmetalpy[complete]&quot;</span>  <span class="c1"># Install all dependencies (equivalent to `pip install jmetalpy`)</span>
+</pre></div>
+</div>
+</div>
 <p>Via source code:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> git clone https://github.com/jMetal/jMetalPy.git
 <span class="gp">$</span> python setup.py install
@@ -184,7 +192,7 @@ <h2>Summary of features<a class="headerlink" href="#summary-of-features" title="
 <li><p>Encodings: real, binary, permutations.</p></li>
 <li><p>Operators: selection (binary tournament, ranking and crowding distance, random, nary random, best solution), crossover (single-point, SBX), mutation (bit-blip, polynomial, uniform, random).</p></li>
 <li><p>Quality indicators: hypervolume, additive epsilon, GD, IGD.</p></li>
-<li><p>Pareto front plotting for problems with two or more objectives (as scatter plot/parallel coordinates/chordplot) in real-time, static or interactive.</p></li>
+<li><p>Pareto front approximation plotting in real-time, static or interactive.</p></li>
 <li><p>Experiment class for performing studies either alone or alongside jMetal.</p></li>
 <li><p>Pairwise and multiple hypothesis testing for statistical analysis, including several frequentist and Bayesian testing methods, critical distance plots and posterior diagrams.</p></li>
 </ul>

source/conf.py → docs/source/conf.py

@@ -2,7 +2,7 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('../../'))
 
 # -- Project information -----------------------------------------------------
 

source/index.rst → docs/source/index.rst

@@ -31,8 +31,15 @@ Via pip:
 .. code-block:: console
 
     $ pip install jmetalpy
-    $ pip install "jmetalpy[core]"  # Install core components of the framework
-    $ pip install "jmetalpy[complete]"  # Install also dependencies for distributed computing
+
+.. note:: Alternatively, you can use one of these instead:
+
+    .. code-block:: console
+
+        $ pip install "jmetalpy[core]"  # Install core components of the framework
+        $ pip install "jmetalpy[docs]"  # Install requirements for building docs
+        $ pip install "jmetalpy[distributed]"  # Install requirements for parallel/distributed computing
+        $ pip install "jmetalpy[complete]"  # Install all dependencies (equivalent to `pip install jmetalpy`)
 
 Via source code:
 
@@ -51,7 +58,7 @@ The current release of jMetalPy (v1.5.3) contains the following components:
 * Encodings: real, binary, permutations.
 * Operators: selection (binary tournament, ranking and crowding distance, random, nary random, best solution), crossover (single-point, SBX), mutation (bit-blip, polynomial, uniform, random).
 * Quality indicators: hypervolume, additive epsilon, GD, IGD.
-* Pareto front plotting for problems with two or more objectives (as scatter plot/parallel coordinates/chordplot) in real-time, static or interactive.
+* Pareto front approximation plotting in real-time, static or interactive.
 * Experiment class for performing studies either alone or alongside jMetal.
 * Pairwise and multiple hypothesis testing for statistical analysis, including several frequentist and Bayesian testing methods, critical distance plots and posterior diagrams.
 

setup.py

@@ -18,7 +18,7 @@
 ]
 extras_require = {
     'core': install_requires,
-    'doc': install_requires + ['jupyter', 'nbsphinx'],
+    'docs': install_requires + ['jupyter', 'nbsphinx'],
     'distributed': install_requires + ['dask[complete]>=1.2.2', 'distributed>=1.28.1', 'pyspark>=2.4.0']
 }
 extras_require['complete'] = {v for req in extras_require.values() for v in req}