Merge pull request #42 from inpefess/doc-coverage

Doc coverage
inpefess · Jan 10, 2022 · 01f3274 · 01f3274
2 parents 7219ff9 + e314a1f
commit 01f3274
Show file tree

Hide file tree

Showing 20 changed files with 449 additions and 448 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1,14 +1,20 @@
 Dockerfile
 venv*/
 dist/
-doc/build/
-.mypy_cache/
-.pytest_cache/
-__pycache__/
-examples/tty.gif
+doc/
+./**/.*
+./**/__pycache__/
+./**/*.gif
 examples/video_example/
 examples/output/
-examples/session.log
-examples/.mypy_cache/
-examples/.ipynb_checkpoints/
-.idea/
+examples/document/
+./**/*.log
+./**/*.*~
+./**/*~
+show_report.sh
+./**/.ini
+./**/.yml
+./**/.toml
+cicm2021paper/
+LICENSE
+tests/
diff --git a/Dockerfile b/Dockerfile
@@ -1,10 +1,16 @@
-FROM makarius/isabelle:Isabelle2021
+FROM makarius/isabelle:Isabelle2021-1
 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
 USER isabelle
-RUN pip install -U pip isabelle-client jupyterlab
-COPY examples ${HOME}
+RUN pip install -U pip jupyterlab
+COPY isabelle_client ${HOME}/isabelle_client
+COPY pyproject.toml ${HOME}
+COPY poetry.lock ${HOME}
+COPY README.rst ${HOME}
+RUN pip install .
 ENTRYPOINT []
diff --git a/README.rst b/README.rst
@@ -35,7 +35,7 @@ from documentation, run the
 or use ``isabelle-client`` from a
 `notebook <https://github.com/inpefess/isabelle-client/blob/master/examples/example.ipynb>`__,
 e.g. with
-`Binder <https://mybinder.org/v2/gh/inpefess/isabelle-client/HEAD?labpath=example.ipynb>`__.
+`Binder <https://mybinder.org/v2/gh/inpefess/isabelle-client/HEAD?labpath=isabelle-client-examples/example.ipynb>`__.
 
 How to Contribute
 =================
@@ -93,5 +93,5 @@ DOI <https://doi.org/10.1007/978-3-030-81097-9_20>`__.
 .. |codecov| image:: https://codecov.io/gh/inpefess/isabelle-client/branch/master/graph/badge.svg
    :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=example.ipynb
+   :target: https://mybinder.org/v2/gh/inpefess/isabelle-client/HEAD?labpath=isabelle-client-examples/example.ipynb
 .. |video tutorial| image:: ../../examples/tty.gif
diff --git a/conftest.py b/conftest.py
@@ -1,18 +1,17 @@
-"""
-Copyright 2021 Boris Shminke
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
+# Copyright 2021-2022 Boris Shminke
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+""" Fixtures for unit tests live here """
 import socketserver
 import threading
 from unittest.mock import Mock

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -1,19 +1,17 @@
 # type: ignore
-"""
-Copyright 2021 Boris Shminke
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    https://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
+# Copyright 2021-2022 Boris Shminke
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 # pylint: disable-all
 # -- Path setup --------------------------------------------------------------
 
@@ -38,7 +36,7 @@
 # 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"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.coverage"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -13,7 +13,7 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 
-.. include:: ../../README.rst  
+.. include:: ../../README.rst
 
 .. toctree::
    :maxdepth: 3

diff --git a/doc/source/package-documentation.rst b/doc/source/package-documentation.rst
@@ -17,43 +17,11 @@
 Package Documentation
 **********************
 
-Isabelle Client
-^^^^^^^^^^^^^^^^
-.. autoclass:: isabelle_client.IsabelleClient
-   :special-members: __init__
+.. automodule:: isabelle_client.isabelle__client
    :members:
-
-socket_communication
-^^^^^^^^^^^^^^^^^^^^^
-.. currentmodule:: isabelle_client.socket_communication
-
-A collection of functions for TCP communication.
-
-Isabelle Response
-==================
-.. autoclass:: isabelle_client.IsabelleResponse
-   :special-members: __init__
+.. automodule:: isabelle_client.socket_communication
+   :members:
+.. automodule:: isabelle_client.compatibility_helper
+   :members:
+.. automodule:: isabelle_client.utils
    :members:
-
-.. autofunction:: get_response_from_isabelle
-.. autofunction:: get_final_message
-
-utils
-^^^^^^
-.. currentmodule:: isabelle_client.utils
-
-A collection of different useful functions.
-
-.. autofunction:: start_isabelle_server
-.. autofunction:: get_isabelle_client
-
-compatibility_helper
-^^^^^^^^^^^^^^^^^^^^^
-.. currentmodule:: isabelle_client.compatibility_helper
-
-A module helping to run `asyncio`_ in Python 3.6
-
-.. autofunction:: async_run
-
-
-.. _asyncio: https://docs.python.org/3/library/asyncio.html
diff --git a/doc/source/usage-example.rst b/doc/source/usage-example.rst
@@ -12,9 +12,7 @@
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-
-.. _usage-example:
-
+
 Basic usage example
 ********************