Merge pull request #20 from UCREL/language-documentation

Language documentation
UCREL · Dec 11, 2021 · 4b09298 · 4b09298
2 parents 207e023 + c18f092
commit 4b09298
Show file tree

Hide file tree

Showing 4 changed files with 553 additions and 2 deletions.
diff --git a/docs/docs/usage/getting_started/_category_.yml b/docs/docs/usage/getting_started/_category_.yml
@@ -1 +1,2 @@
-label: 'Getting Started'
+label: 'Getting Started'
+position: 1.5
diff --git a/docs/docs/usage/getting_started/using_pymusas.md b/docs/docs/usage/getting_started/using_pymusas.md
@@ -71,7 +71,9 @@ As we can see the [USAS tagger](/api/spacy_api/taggers/rule_based) has been adde
 
 Before using the added tagger we need to add the single word Portuguese USAS lexicon to the tagger, to do this we first need to download the lexicon form the [Multilingual USAS repository](https://github.com/UCREL/Multilingual-USAS) and then add the lexicon with and without the POS information (the code example below carries on from the previous).
 
-**NOTE** when it downloads the lexicon it will be saved within the [PYMUSAS_CACHE_HOME](/api/config) directory for caching, which by default is set to `~/.cache/pymusas`, this can be changed either by setting `pymusas.config.PYMUSAS_CACHE_HOME` within the code you are writing or by setting the `PYMUSAS_HOME` environment variable.
+:::note
+When it downloads the lexicon it will be saved within the [PYMUSAS_CACHE_HOME](/api/config) directory for caching, which by default is set to `~/.cache/pymusas`, this can be changed either by setting `pymusas.config.PYMUSAS_CACHE_HOME` within the code you are writing or by setting the `PYMUSAS_HOME` environment variable.
+:::
 
 ``` python
 from pymusas.file_utils import download_url_file

diff --git a/docs/docs/usage/how_to/_category_.yml b/docs/docs/usage/how_to/_category_.yml
@@ -0,0 +1,2 @@
+label: 'How-to'
+position: 2.5