Merge pull request #453 from bluescarni/pr/docs_additions

Doc update and try using the latest sphinx in the CI.
esa · Sep 24, 2020 · de3d0b5 · de3d0b5
2 parents 110e478 + 98894c2
commit de3d0b5
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 8 deletions.
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
@@ -47,11 +47,27 @@ problems, stochastic and deterministic problems, as well as to perform
 research on novel algorithms and paradigms and easily compare
 them to state-of-the-art implementations of established ones.
 
-If you are using pagmo as part of your research, teaching, or other
-activities, we would be grateful if you could star
-the repository and/or cite our work. The DOI of the latest version
-and other citation resources are available
-at `this link <https://doi.org/10.5281/zenodo.1045336>`__.
+If you are using pagmo as part of your research, teaching, or other activities, we would be grateful if you could star
+the repository and/or cite our work. For citation purposes, you can use the following BibTex entry, which refers
+to the `pagmo paper <https://doi.org/10.21105/joss.02338>`__ in the Journal of Open Source Software:
+
+.. code-block:: bibtex
+
+   @article{Biscani2020,
+     doi = {10.21105/joss.02338},
+     url = {https://doi.org/10.21105/joss.02338},
+     year = {2020},
+     publisher = {The Open Journal},
+     volume = {5},
+     number = {53},
+     pages = {2338},
+     author = {Francesco Biscani and Dario Izzo},
+     title = {A parallel global multiobjective framework for optimization: pagmo},
+     journal = {Journal of Open Source Software}
+   }
+
+The DOI of the latest version of the software is available at
+`this link <https://doi.org/10.5281/zenodo.1045336>`__.
 
 If you prefer using Python rather than C++, pagmo
 can be used from Python via `pygmo <https://github.com/esa/pygmo2>`__,

diff --git a/tools/circleci_bionic_clang6_release.sh b/tools/circleci_bionic_clang6_release.sh
@@ -15,7 +15,7 @@ export deps_dir=$HOME/local
 export PATH="$HOME/miniconda/bin:$PATH"
 bash miniconda.sh -b -p $HOME/miniconda
 conda config --add channels conda-forge --force
-conda_pkgs="cmake eigen nlopt ipopt boost-cpp tbb tbb-devel python=3.7 sphinx<3 sphinx_rtd_theme breathe"
+conda_pkgs="cmake eigen nlopt ipopt boost-cpp tbb tbb-devel python=3.7 sphinx sphinx_rtd_theme breathe"
 conda create -q -p $deps_dir -y
 source activate $deps_dir
 conda install $conda_pkgs -y

diff --git a/tools/circleci_bionic_gcc7_coverage.sh b/tools/circleci_bionic_gcc7_coverage.sh
@@ -15,7 +15,7 @@ export deps_dir=$HOME/local
 export PATH="$HOME/miniconda/bin:$PATH"
 bash miniconda.sh -b -p $HOME/miniconda
 conda config --add channels conda-forge --force
-conda_pkgs="cmake eigen nlopt ipopt boost-cpp tbb tbb-devel python=3.7 sphinx<3 sphinx_rtd_theme breathe"
+conda_pkgs="cmake eigen nlopt ipopt boost-cpp tbb tbb-devel python=3.7 sphinx sphinx_rtd_theme breathe"
 conda create -q -p $deps_dir -y
 source activate $deps_dir
 conda install $conda_pkgs -y

diff --git a/tools/circleci_focal_gcc9_docs.sh b/tools/circleci_focal_gcc9_docs.sh
@@ -15,7 +15,7 @@ export deps_dir=$HOME/local
 export PATH="$HOME/miniconda/bin:$PATH"
 bash miniconda.sh -b -p $HOME/miniconda
 conda config --add channels conda-forge --force
-conda_pkgs="cmake eigen nlopt ipopt boost-cpp tbb tbb-devel python=3.7 sphinx<3 sphinx_rtd_theme breathe"
+conda_pkgs="cmake eigen nlopt ipopt boost-cpp tbb tbb-devel python=3.7 sphinx sphinx_rtd_theme breathe"
 conda create -q -p $deps_dir -y
 source activate $deps_dir
 conda install $conda_pkgs -y