remove docs website, moved to trapi-predict-kit

MaastrichtU-IDS · Jul 21, 2023 · d7dabd0 · d7dabd0
1 parent e24a2cc
commit d7dabd0
Show file tree

Hide file tree

Showing 41 changed files with 131 additions and 1,184 deletions.
diff --git a/.github/workflows/test-integration.yml b/.github/workflows/test-integration.yml
@@ -79,27 +79,3 @@ jobs:
     - name: Test with pytest with coverage
       run: |
         pytest -s --cov src/openpredict --cov-report xml:coverage.xml tests/integration/*
-
-
-  build-docs:
-    needs: [ tests ]
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.9
-
-      - name: Install dependencies
-        run: |
-          pip install ".[doc]"
-
-      - name: Deploy mkdocs on GitHub Pages
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          git pull
-          mkdocs gh-deploy
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -193,26 +193,6 @@ Push to the [MaastrichtU-IDS GitHub Container Registry](https://github.com/orgs/
 docker push ghcr.io/maastrichtu-ids/openpredict-api:latest
 ```
 
-### 📖 Generate pydoc for the code
-
-Documentation in [docs/README-pydoc.md](https://github.com/MaastrichtU-IDS/translator-openpredict/tree/master/docs/README-pydoc.md) is generated from the Python source code doc strings using [pydoc-markdown](https://pydoc-markdown.readthedocs.io/en/latest/).
-
-```bash
-pip3 install pydoc-markdown
-```
-
-Generate markdown documentation page for the `openpredict` package in `docs/`
-
-```bash
-pydoc-markdown --render-toc -p openpredict > docs/README-pydoc.md
-```
-
-Modify the generated page title automatically:
-
-```bash
-find docs/README-pydoc.md -type f -exec sed -i "s/# Table of Contents/# OpenPredict Package documentation 🔮🐍/g" {} +
-```
-
 ### Update the TRAPI version
 
 Get the latest TRAPI YAML: https://github.com/NCATSTranslator/ReasonerAPI/blob/master/TranslatorReasonerAPI.yaml

diff --git a/README.md b/README.md
@@ -134,8 +134,8 @@ The `/predicates` operation will return the entities and relations provided by t
 
 We provide [Jupyter Notebooks](https://jupyter.org/) with examples to use the OpenPredict API:
 
-1. [Query the OpenPredict API](https://github.com/MaastrichtU-IDS/translator-openpredict/blob/master/docs/openpredict-examples.ipynb)
-2. [Generate embeddings with pyRDF2Vec](https://github.com/MaastrichtU-IDS/translator-openpredict/blob/master/docs/openpredict-pyrdf2vec-embeddings.ipynb), and import them in the OpenPredict API
+1. [Query the OpenPredict API](https://github.com/MaastrichtU-IDS/translator-openpredict/blob/master/resources/openpredict-examples.ipynb)
+2. [Generate embeddings with pyRDF2Vec](https://github.com/MaastrichtU-IDS/translator-openpredict/blob/master/resources/openpredict-pyrdf2vec-embeddings.ipynb), and import them in the OpenPredict API
 
 #### Add embedding :station:
 
@@ -171,7 +171,7 @@ The API will return the list of predicted target for the given entity, the label
 
 Diagram of the data model used for OpenPredict, based on the ML Schema ontology (`mls`):
 
-![OpenPredict datamodel](https://raw.githubusercontent.com/MaastrichtU-IDS/translator-openpredict/master/docs/OpenPREDICT_datamodel.jpg)
+![OpenPredict datamodel](https://raw.githubusercontent.com/MaastrichtU-IDS/translator-openpredict/master/resources/OpenPREDICT_datamodel.jpg)
 
 ---
 

diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/assets/FAIR_data_principles.png b/docs/assets/FAIR_data_principles.png
diff --git a/docs/assets/custom.css b/docs/assets/custom.css
diff --git a/docs/assets/fontawesome.min.js b/docs/assets/fontawesome.min.js
diff --git a/docs/assets/icon.png b/docs/assets/icon.png
diff --git a/docs/assets/solid.min.js b/docs/assets/solid.min.js
diff --git a/docs/getting-started/create-model.md b/docs/getting-started/create-model.md