From 90d670ae9580c25e4a5c41d36a843e95079e8f52 Mon Sep 17 00:00:00 2001
From: manonBlanco <blanco@teklia.com>
Date: Mon, 15 Jan 2024 16:52:33 +0100
Subject: [PATCH] Update the documentation
---
README.md | 1 +
docs/get_started/index.md | 6 ++++++
mkdocs.yml | 2 +-
3 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index cc24d3a2..f3526541 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ This is an open-source project, licensed using [the MIT license](https://opensou
For development and tests purpose it may be useful to install the project as a editable package with pip.
- Use a virtualenv (e.g. with virtualenvwrapper `mkvirtualenv -a . dan`)
+- Initialize the [`Nerval`](https://gitlab.teklia.com/ner/nerval) submodule (e.g. `git submodule update --init --recursive`)
- Install `dan` as a package (e.g. `pip install -e .`)
### Linter
diff --git a/docs/get_started/index.md b/docs/get_started/index.md
index ddc34d0f..90e88151 100644
--- a/docs/get_started/index.md
+++ b/docs/get_started/index.md
@@ -26,6 +26,12 @@ To install DAN manually, you need to first clone via:
git clone git@gitlab.teklia.com:atr/dan.git
```
+Then you can initialize the [`Nerval`](https://gitlab.teklia.com/ner/nerval) submodule:
+
+```shell
+git submodule update --init --recursive
+```
+
Then you can install it via pip:
```shell
diff --git a/mkdocs.yml b/mkdocs.yml
index 758964ce..3ac3aea2 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -144,7 +144,7 @@ extra:
link: https://teklia.com
- icon: fontawesome/brands/gitlab
name: Git repository for this project
- link: https://gitlab.com/teklia/atr/dan
+ link: https://gitlab.teklia.com/atr/dan
- icon: fontawesome/brands/linkedin
name: Teklia @ LinkedIn
link: https://www.linkedin.com/company/teklia
--
GitLab