Update docs (#441)

* Initial commit * Change python 3.5 references to 3.6 * Update files related to documentation-generation. * Update CONTRIBUTING.rst * Update CONTRIBUTING.rst * Update README.md
elfi-dev · Dec 16, 2022 · 7c7a55e · 7c7a55e
1 parent 67e6ed9
commit 7c7a55e
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,8 @@
 Changelog
 =========
 
+
+- Update documentation-related files: docs, conf.py and requirements-dev.txt 
 - Update PULL_REQUEST_TEMPLATE.md
 - Drop tests for py36 and add tests for py39 and py310
 - Fix couple of minor bugs in `ar1`-model

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -136,7 +136,7 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.md.
-3. The pull request should work for Python 3.7, or later. Check
+3. The pull request should work for Python 3.7 and later. Check
    https://github.com/elfi-dev/elfi/actions/workflows/pytest.yml
    and make sure that the tests pass for all supported Python versions.
 

diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ with your default Python environment and can easily use different versions of Py
 in different projects. You can create a virtual environment for ELFI using anaconda with:
 
 ```
-conda create -n elfi python=3.6 numpy
+conda create -n elfi python=3.7 numpy
 source activate elfi
 pip install elfi
 ```

diff --git a/docs/conf.py b/docs/conf.py
@@ -92,6 +92,7 @@ def setup(app):
     'sphinx.ext.viewcode',
     'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
+    'IPython.sphinxext.ipython_console_highlighting',
     # Inheritance diagrams
     # 'sphinx.ext.graphviz',
     # 'sphinx.ext.inheritance_diagram',
@@ -134,7 +135,7 @@ def setup(app):
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -3,7 +3,7 @@ Quickstart
 
 First ensure you have
 `installed <http://elfi.readthedocs.io/en/stable/installation.html>`__
-Python 3.6 (or greater) and ELFI. After installation you can start using
+Python 3.7 (or greater) and ELFI. After installation you can start using
 ELFI:
 
 .. code:: ipython3

diff --git a/docs/usage/parallelization.rst b/docs/usage/parallelization.rst
@@ -157,7 +157,7 @@ start a local cluster to the background using 4 CPU cores:
 
 .. code:: ipython3
 
-    !ipcluster start -n 4 --daemon
+    !ipcluster start -n 4 --daemonize
     
     # This is here just to ensure that ipcluster has enough time to start properly before continuing
     import time

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -16,3 +16,5 @@ importlib-metadata<5.0.0
 
 # Documentation
 Sphinx>=1.4.8
+sphinx-rtd-theme>=1.1.1
+jupyter>=1.0.0