Feature/update docs (#15)

* Updated Sphinx documentation

New Index.rst page,
Old index.rst page became corese.rst.
Added new pages: python_api/api_root.rst with autogenerated API doc.
Added python_api/bridges.rst page
The example1.ipynb notebook is rendered as a uset_guide.
INSTALL.md is rendered as an installation page

* Updated pyproject.toml

* Moved VIESION.txt to src/pycorese to update the version only in one place.

* Minor fixes and updates

Author: AnnaBobasheva

CHANGES.md

@@ -1,8 +1,19 @@
 # Changelog
 
+## Version 0.1.5
+
+- added corese-python/pycorese API documentation
+- wraps corese-core v4.6.0
+
+## Version 0.1.4
+
+- downgraded version to 0.1.4 since it's not ready for 1.0.0 yet
+- updated markdown documentation
+- wraps corese-core v4.6.0
+
 ## Version 1.0.1
 
-- document local installaiton process (INSTALL.md)
+- document local installation process (INSTALL.md)
 - build jar file then running `python -m build` (may need more work)
 - add doc skeleton and github action files
 - add coreseVersion (not fully implemented yet)

VERSION.txt

@@ -22,8 +22,8 @@ sphinx-multiversion docs/source build/html
 
 ## Switcher generation
 
-- To navigate between versions by means of the switcher (the dropdown list indicating the available version), the switcher.json object must be generated. 
-- To improve navigability, a landing page must also be generated to redirect to the latest version of the documentation. 
+- To navigate between versions by means of the switcher (the dropdown list indicating the available version), the switcher.json object must be generated.
+- To improve navigability, a landing page must also be generated to redirect to the latest version of the documentation.
 
 To this end a script must be executed and write the output to the output html directory:
 
@@ -33,4 +33,4 @@ To this end a script must be executed and write the output to the output html di
 
 Both sphinx-multiversion and switcher_generator work on tags following the ```^v[0-9]+\.[0-9]+\.[0-9]+$``` syntax and ordered by refname.
 
-The minimal version set in the switcher_generator allows to not generate entries in the switcher and landing page for unexisting or uncompatible documentation.
+The minimal version set in the switcher_generator allows to not generate entries in the switcher and landing page for nonexisting or incompatible documentation.

docs/README.md

@@ -4,11 +4,13 @@ build-backend = "setuptools.build_meta"
 
 
 [tool.setuptools.dynamic]
-version = { file = "VERSION.txt" }
+version = { file = "src/pycorese/VERSION.txt" }
+readme = { file = "README.md" }
+
 
 [project]
 name = "pycorese"
-dynamic = ["version"]
+dynamic = ["version", "readme"]
 authors = [
     { name = "Corese Team", email = "corese@inria.fr" },
     { name = "Anna Bobasheva", email = "anna.bobasheva@inria.fr" },
@@ -19,7 +21,7 @@ authors = [
 description = "pycorese: Python API for CORESE Semantic Web platform"
 keywords = ["Query Engine", "SPARQL", "SHACL", "RDF",
             "RDFS", "OWL", "Reasoning", "Knowledge Graph"]
-readme = "README.md"
+
 license = {file = "LICENSE"}
 requires-python = ">=3.10"
 dependencies = [
@@ -66,9 +68,11 @@ include-package-data = true
 where = ["src"]
 
 # Adding the Java jars to the package.
-# The jar files are built by the custom build step in the setup.py.
-# One jar is built by the gradle build system,
-# the other is downloaded from the maven repository.
-# Both are copied to the `resources` directory.
+# The jar files are obtained by the custom `sdist` step in the setup.py.
+# (1) corese-python-{version}-with-dependencies.jar is built by the gradle build system,
+# (2) corese-core-{version}-with-dependencies.jar is downloaded from the maven repository
+#     (https://mvnrepository.com/artifact/fr.inria.corese/corese-core).
+# Both files are copied to the `resources` directory
+# and installed to the `share/pycorese` directory of the venv.
 [tool.setuptools.data-files]
 "share/pycorese" = ["resources/*.jar"]

pyproject.toml

@@ -0,0 +1 @@
+0.1.5

src/pycorese/VERSION.txt

@@ -1,10 +1,17 @@
 """The module provides a wrapper to corese library (Software platform for the Semantic Web of Linked Data)"""
 
+from .api import CoreseAPI
 
-__version__ = '1.0.1'
-__version_info__ = tuple([ int(num) for num in __version__.split('.')])
+all = ['CoreseAPI']
 
-from .api import CoreseAPI
+# Read version of the package from the file
+# that is in the project rood directory
+from pathlib import Path
+
+with open(Path(__file__).parent / "VERSION.txt") as _f:
+    __version__ = _f.read().strip()
+
+__version_info__ = tuple([ int(num) for num in __version__.split('.')])
 
 import logging