update git+https and gh_pages link after public release (#9)

graphcore-research · Jun 17, 2024 · de86b8d · de86b8d
1 parent a3fb9e2
commit de86b8d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 
 A Python toolbox to compute topological metrics and statistics for Knowledge Graphs.
 
-Documentation can be found at https://curly-barnacle-lnejye6.pages.github.io/
+Documentation can be found at https://graphcore-research.github.io/kg-topology-toolbox/
 
 For a walkthrough of the main functionalities, we provide an introductory [Jupyter notebook](docs/source/notebooks/ogb_biokg_demo.ipynb).
 
@@ -15,7 +15,7 @@ To install the `kg-topology-toolbox` library, run
 
 ```
 pip install wheel
-pip install git+ssh://git@github.com/graphcore-research/kg-topology-toolbox
+pip install git+https://github.com/graphcore-research/kg-topology-toolbox.git
 ```
 
 4\. Import and use:

diff --git a/docs/source/notebooks/ogb_biokg_demo.ipynb b/docs/source/notebooks/ogb_biokg_demo.ipynb
@@ -31,7 +31,7 @@
    "source": [
     "import sys\n",
     "!{sys.executable} -m pip uninstall -y kg_topology_toolbox\n",
-    "!pip install -q git+ssh://git@github.com/graphcore-research/kg-topology-toolbox\n",
+    "!pip install -q git+https://github.com/graphcore-research/kg-topology-toolbox.git\n",
     "!pip install -q jupyter ipywidgets ogb seaborn"
    ]
   },

diff --git a/docs/source/user_guide.rst b/docs/source/user_guide.rst
@@ -7,7 +7,8 @@ Installation and usage
 1. Pip install :code:`kg-topology-toolbox`:
 
 .. code-block::
-
+    
+    pip install wheel
     pip install git+https://github.com/graphcore-research/kg-topology-toolbox.git
 
 2. Import and use: