Merge pull request #47 from inpefess/maintenance

CI with different python versions

.circleci/config.yml

@@ -2,14 +2,19 @@ version: 2.1
 
 jobs:
   build-and-test:
+    parameters:
+      python_version:
+        description: "Python version to test against"
+        default: "3.10.4"
+        type: string
     docker:
-      - image: cimg/python:3.10.0
+      - image: cimg/python:<< parameters.python_version >>
     working_directory: ~/repo
     steps:
       - checkout
       - restore_cache:
           keys:
-            - v2-dependencies-{{ checksum "poetry.lock" }}
+            - v1-dependencies-<< parameters.python_version >>-{{ checksum "poetry.lock" }}
       - run:
           name: install dependencies
           command: |
@@ -49,6 +54,13 @@ jobs:
           path: test-results
 
 workflows:
-  main:
+  workflow:
     jobs:
-      - build-and-test
+      - build-and-test:
+          python_version: "3.7.13"
+      - build-and-test:
+          python_version: "3.8.13"
+      - build-and-test:
+          python_version: "3.9.12"
+      - build-and-test:
+          python_version: "3.10.4"

.dockerignore

@@ -7,8 +7,8 @@ doc/
 ./**/*.gif
 examples/video_example/
 examples/output/
-examples/document/
 ./**/*.log
+./**/*.pdf
 ./**/*.*~
 ./**/*~
 local-build.sh

.gitignore

@@ -17,3 +17,4 @@ doc/build/
 .ipynb_checkpoints/
 flycheck_*.*
 .dir-locals.el
+examples/output/

Dockerfile

@@ -1,14 +1,14 @@
 FROM makarius/isabelle:Isabelle2021-1
-ENV HOME=/home/isabelle
-ENV PATH=${HOME}/.local/bin:${HOME}/Isabelle/bin:${PATH}
+ENV HOME=/home/isabelle/
+ENV PATH=${HOME}/.local/bin/:${HOME}/Isabelle/bin/:${PATH}
 USER root
 RUN apt-get update
 RUN apt-get install -y python3-pip
-COPY examples ${HOME}/isabelle-client-examples
-RUN chown -R isabelle ${HOME}/isabelle-client-examples
+COPY examples/ ${HOME}/isabelle-client-examples/
+RUN chown -R isabelle ${HOME}/isabelle-client-examples/
 USER isabelle
 RUN pip install -U pip jupyterlab
-COPY isabelle_client ${HOME}/isabelle_client
+COPY isabelle_client/ ${HOME}/isabelle_client/
 COPY pyproject.toml ${HOME}
 COPY poetry.lock ${HOME}
 COPY README.rst ${HOME}

README.rst

@@ -82,7 +82,10 @@ More documentation can be found
 Video example
 =============
 
-|video tutorial|.
+.. image:: ../../examples/tty.gif
+  :alt:
+
+(if not displayed correctly on this page, please watch `here <https://isabelle-client.readthedocs.io/en/latest/#video-example>`__).
 
 How to cite
 ===========
@@ -103,4 +106,4 @@ DOI <https://doi.org/10.1007/978-3-030-81097-9_20>`__.
    :target: https://codecov.io/gh/inpefess/isabelle-client
 .. |Binder| image:: https://mybinder.org/badge_logo.svg
    :target: https://mybinder.org/v2/gh/inpefess/isabelle-client/HEAD?labpath=isabelle-client-examples/example.ipynb
-.. |video tutorial| image:: ../../examples/tty.gif
+

doc/source/conf.py

@@ -13,43 +13,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # pylint: disable-all
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import os
 import sys
 
 sys.path.insert(0, os.path.abspath("../.."))
-
-
-# -- Project information -----------------------------------------------------
-
 project = "isabelle-client"
-copyright = "2021, Boris Shminke"
+copyright = "2021-2022, Boris Shminke"
 author = "Boris Shminke"
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.coverage"]
-
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
-
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = "sphinx_rtd_theme"

isabelle_client/__init__.py

@@ -17,4 +17,4 @@
 from isabelle_client.socket_communication import IsabelleResponse
 from isabelle_client.utils import get_isabelle_client, start_isabelle_server
 
-__version__ = "0.3.4"
+__version__ = "0.3.5"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "isabelle-client"
-version = "0.3.4"
+version = "0.3.5"
 description = "A client to Isabelle proof assistant server"
 authors = ["Boris Shminke <boris@shminke.ml>"]
 license = "Apache-2.0"