📝 Fix docs

MAIF · Dec 13, 2023 · cbab254 · cbab254
1 parent 9434875
commit cbab254
Show file tree

Hide file tree

Showing 47 changed files with 20 additions and 20 deletions.
diff --git a/.gitignore b/.gitignore
@@ -92,7 +92,7 @@ runs/
 
 # mkdocs documentation
 /site
-/docs/site
+/tmp_docs/site
 
 # mypy
 .mypy_cache/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,12 +14,12 @@ repos:
         exclude: ^chart/
     -   id: debug-statements
     -   id: end-of-file-fixer
-        exclude: ^(docs/|gdocs/)
+        exclude: ^(tmp_docs/|gdocs/)
     -   id: pretty-format-json
         args: ['--autofix']
     -   id: trailing-whitespace
         args: ['--markdown-linebreak-ext=md']
-        exclude: ^(docs/|gdocs/)
+        exclude: ^(tmp_docs/|gdocs/)
     -   id: check-added-large-files
         args: ['--maxkb=500']
     - id: no-commit-to-branch
@@ -40,7 +40,7 @@ repos:
     rev: 6.0.0
     hooks:
     -   id: flake8
-        exclude: '^tests/|^docs'
+        exclude: '^tests/|^tmp_docs'
         args: ['--ignore=E501,D2,D3,D4,D104,D100,D106,D107,W503,D105,E203']
         additional_dependencies: [ flake8-docstrings, "flake8-bugbear==22.8.23" ]
 -   repo: https://github.com/pre-commit/mirrors-isort
@@ -56,7 +56,7 @@ repos:
 -   repo: https://github.com/asottile/blacken-docs
     rev: v1.8.0
     hooks:
-    -   id: blacken-docs
+    -   id: blacken-tmp_docs
         additional_dependencies: [black==21.12b0]
 -   repo: https://github.com/compilerla/conventional-pre-commit
     rev: v2.1.1

diff --git a/README.md b/README.md
@@ -11,8 +11,8 @@ All new features can be found in the **full pipeline [tutorial](https://github.c
 
 # Melusine
 
-<!-- <img src=`docs/_static/melusine.png` width=`200`/> -->
-![](docs/_static/melusine.png)
+<!-- <img src=`tmp_docs/_static/melusine.png` width=`200`/> -->
+![](tmp_docs/_static/melusine.png)
 
 - Free software: Apache Software License 2.0
 - Documentation: [https://melusine.readthedocs.io](https://melusine.readthedocs.io).
@@ -34,8 +34,8 @@ Use **Melusine** if you need a library which:
 
 This package is designed for the preprocessing, classification and automatic summarization of emails written in french.
 
-<!-- <img src=`docs/_static/schema_1.png` width=`600`/> -->
-![](docs/_static/schema_1.png)
+<!-- <img src=`tmp_docs/_static/schema_1.png` width=`600`/> -->
+![](tmp_docs/_static/schema_1.png)
 
 **3 main subpackages are offered :**
 
@@ -237,7 +237,7 @@ y_res = nn_model.predict(X)
 ```
 
 Training with tensorflow 2 can be monitored using tensorboard :
-![](docs/_static/tensorboard.png)
+![](tmp_docs/_static/tensorboard.png)
 
 ## Glossary
 
@@ -312,7 +312,7 @@ To run the app, run the following command in your terminal in the melusine/data
 streamlit run dashboard_app.py
 ```
 
-![](docs/_static/demo_dashboard.gif)
+![](tmp_docs/_static/demo_dashboard.gif)
 
 ### Ethics Guidelines
 
@@ -322,4 +322,4 @@ The document and criteria are derived in particular from the work of the Europea
 
 The pdf file is located in the melusine/ethics_guidelines directory :
 
-![](docs/_static/demo_ethics_guide.gif)
+![](tmp_docs/_static/demo_ethics_guide.gif)
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -10,7 +10,7 @@
 pytest_plugins = [
     "tests.fixtures.backend",
     "tests.fixtures.basic_emails",
-    "tests.fixtures.docs",
+    "tests.fixtures.tmp_docs",
     "tests.fixtures.pipelines",
     "tests.fixtures.processors",
 ]

diff --git a/tests/fixtures/docs.py b/tests/fixtures/docs.py
@@ -5,12 +5,12 @@
 import pytest
 
 # Package source root
-docs_folder = Path(__file__).parents[2] / "docs"
+docs_folder = Path(__file__).parents[2] / "tmp_docs"
 
 
 @pytest.fixture
 def add_docs_to_pythonpath() -> Generator[None, None, None]:
     """Testing"""
-    # Add docs to python path
+    # Add tmp_docs to python path
     sys.path.insert(0, str(docs_folder))
     yield None
diff --git a/tests/processors/test_content_tagger.py b/tests/processors/test_content_tagger.py
@@ -161,11 +161,11 @@ def test_content_tagger_split_text(text, expected_parts):
         ),
         (
             (
-                "Merci de me faire suivre les docs à ma nouvelle adresse qui est 0 rue du parc, 75000 Paris. "
+                "Merci de me faire suivre les tmp_docs à ma nouvelle adresse qui est 0 rue du parc, 75000 Paris. "
                 "Merci d'avance. \nAcceptez notre salutation,"
             ),
             [
-                ("BODY", "Merci de me faire suivre les docs à ma nouvelle adresse qui est 0 rue du parc, 75000 Paris."),
+                ("BODY", "Merci de me faire suivre les tmp_docs à ma nouvelle adresse qui est 0 rue du parc, 75000 Paris."),
                 ("THANKS", "Merci d'avance."),
                 ("GREETINGS", "Acceptez notre salutation,"),
             ],
@@ -234,13 +234,13 @@ def test_content_tagger_split_text(text, expected_parts):
             (
                 "chère madame,\n"
                 "URGENT URGENT\n"
-                "Merci de me faire suivre les docs à ma nouvelle adresse qui est 0 rue du parc, 75000 Paris. "
+                "Merci de me faire suivre les tmp_docs à ma nouvelle adresse qui est 0 rue du parc, 75000 Paris. "
                 "Merci d'avance. \nRecevez nos salutations,\nVous en souhaitant bonne réception"
             ),
             [
                 ("HELLO", "chère madame,"),
                 ("BODY", "URGENT URGENT"),
-                ("BODY", "Merci de me faire suivre les docs à ma nouvelle adresse qui est 0 rue du parc, 75000 Paris."),
+                ("BODY", "Merci de me faire suivre les tmp_docs à ma nouvelle adresse qui est 0 rue du parc, 75000 Paris."),
                 ("THANKS", "Merci d'avance."),
                 ("GREETINGS", "Recevez nos salutations,"),
                 ("GREETINGS", "Vous en souhaitant bonne réception"),

diff --git a/docs/_static/melusine.png → tmp_docs/_static/melusine.png b/docs/_static/melusine.png → tmp_docs/_static/melusine.png
diff --git a/docs/advanced/ContentTagger.md → tmp_docs/advanced/ContentTagger.md b/docs/advanced/ContentTagger.md → tmp_docs/advanced/ContentTagger.md
diff --git a/docs/advanced/CustomDetector.md → tmp_docs/advanced/CustomDetector.md b/docs/advanced/CustomDetector.md → tmp_docs/advanced/CustomDetector.md
diff --git a/docs/advanced/ExchangeConnector.md → tmp_docs/advanced/ExchangeConnector.md b/docs/advanced/ExchangeConnector.md → tmp_docs/advanced/ExchangeConnector.md
diff --git a/docs/advanced/PreTrainedModelsHF.md → tmp_docs/advanced/PreTrainedModelsHF.md b/docs/advanced/PreTrainedModelsHF.md → tmp_docs/advanced/PreTrainedModelsHF.md
diff --git a/docs/contribute/how_to_contribute.md → tmp_docs/contribute/how_to_contribute.md b/docs/contribute/how_to_contribute.md → tmp_docs/contribute/how_to_contribute.md
diff --git a/docs/contribute/maif.md → tmp_docs/contribute/maif.md b/docs/contribute/maif.md → tmp_docs/contribute/maif.md
diff --git a/.../docs_src/BasicClassification/__init__.py → .../docs_src/BasicClassification/__init__.py b/.../docs_src/BasicClassification/__init__.py → .../docs_src/BasicClassification/__init__.py
diff --git a/...cs_src/BasicClassification/tutorial001.py → ...cs_src/BasicClassification/tutorial001.py b/...cs_src/BasicClassification/tutorial001.py → ...cs_src/BasicClassification/tutorial001.py
diff --git a/docs/docs_src/Configurations/__init__.py → tmp_docs/docs_src/Configurations/__init__.py b/docs/docs_src/Configurations/__init__.py → tmp_docs/docs_src/Configurations/__init__.py
diff --git a/docs/docs_src/Configurations/tutorial001.py → ...cs/docs_src/Configurations/tutorial001.py b/docs/docs_src/Configurations/tutorial001.py → ...cs/docs_src/Configurations/tutorial001.py
diff --git a/docs/docs_src/GettingStarted/__init__.py → tmp_docs/docs_src/GettingStarted/__init__.py b/docs/docs_src/GettingStarted/__init__.py → tmp_docs/docs_src/GettingStarted/__init__.py
diff --git a/docs/docs_src/GettingStarted/tutorial001.py → ...cs/docs_src/GettingStarted/tutorial001.py b/docs/docs_src/GettingStarted/tutorial001.py → ...cs/docs_src/GettingStarted/tutorial001.py
diff --git a/docs/docs_src/GettingStarted/tutorial002.py → ...cs/docs_src/GettingStarted/tutorial002.py b/docs/docs_src/GettingStarted/tutorial002.py → ...cs/docs_src/GettingStarted/tutorial002.py
diff --git a/docs/docs_src/MelusineDetectors/__init__.py → ...cs/docs_src/MelusineDetectors/__init__.py b/docs/docs_src/MelusineDetectors/__init__.py → ...cs/docs_src/MelusineDetectors/__init__.py
diff --git a/...docs_src/MelusineDetectors/tutorial001.py → ...docs_src/MelusineDetectors/tutorial001.py b/...docs_src/MelusineDetectors/tutorial001.py → ...docs_src/MelusineDetectors/tutorial001.py
diff --git a/...docs_src/MelusineDetectors/tutorial002.py → ...docs_src/MelusineDetectors/tutorial002.py b/...docs_src/MelusineDetectors/tutorial002.py → ...docs_src/MelusineDetectors/tutorial002.py
diff --git a/...docs_src/MelusineDetectors/tutorial003.py → ...docs_src/MelusineDetectors/tutorial003.py b/...docs_src/MelusineDetectors/tutorial003.py → ...docs_src/MelusineDetectors/tutorial003.py
diff --git a/...docs_src/MelusineDetectors/tutorial004.py → ...docs_src/MelusineDetectors/tutorial004.py b/...docs_src/MelusineDetectors/tutorial004.py → ...docs_src/MelusineDetectors/tutorial004.py
diff --git a/docs/docs_src/MelusinePipeline/__init__.py → ...ocs/docs_src/MelusinePipeline/__init__.py b/docs/docs_src/MelusinePipeline/__init__.py → ...ocs/docs_src/MelusinePipeline/__init__.py
diff --git a/.../docs_src/MelusinePipeline/tutorial001.py → .../docs_src/MelusinePipeline/tutorial001.py b/.../docs_src/MelusinePipeline/tutorial001.py → .../docs_src/MelusinePipeline/tutorial001.py
diff --git a/docs/docs_src/MelusineRegex/__init__.py → tmp_docs/docs_src/MelusineRegex/__init__.py b/docs/docs_src/MelusineRegex/__init__.py → tmp_docs/docs_src/MelusineRegex/__init__.py
diff --git a/docs/docs_src/MelusineRegex/tutorial001.py → ...ocs/docs_src/MelusineRegex/tutorial001.py b/docs/docs_src/MelusineRegex/tutorial001.py → ...ocs/docs_src/MelusineRegex/tutorial001.py
diff --git a/...docs_src/MelusineTransformers/__init__.py → ...docs_src/MelusineTransformers/__init__.py b/...docs_src/MelusineTransformers/__init__.py → ...docs_src/MelusineTransformers/__init__.py
diff --git a/...s_src/MelusineTransformers/tutorial001.py → ...s_src/MelusineTransformers/tutorial001.py b/...s_src/MelusineTransformers/tutorial001.py → ...s_src/MelusineTransformers/tutorial001.py
diff --git a/docs/docs_src/Models/__init__.py → tmp_docs/docs_src/Models/__init__.py b/docs/docs_src/Models/__init__.py → tmp_docs/docs_src/Models/__init__.py
diff --git a/docs/docs_src/Models/tutorial001.py → tmp_docs/docs_src/Models/tutorial001.py b/docs/docs_src/Models/tutorial001.py → tmp_docs/docs_src/Models/tutorial001.py
diff --git a/docs/docs_src/__init__.py → tmp_docs/docs_src/__init__.py b/docs/docs_src/__init__.py → tmp_docs/docs_src/__init__.py
diff --git a/docs/history/history.md → tmp_docs/history/history.md b/docs/history/history.md → tmp_docs/history/history.md
diff --git a/docs/index.md → tmp_docs/index.md b/docs/index.md → tmp_docs/index.md
diff --git a/docs/philosophy/philosophy.md → tmp_docs/philosophy/philosophy.md b/docs/philosophy/philosophy.md → tmp_docs/philosophy/philosophy.md
diff --git a/docs/tutorials/00_GettingStarted.md → tmp_docs/tutorials/00_GettingStarted.md b/docs/tutorials/00_GettingStarted.md → tmp_docs/tutorials/00_GettingStarted.md
diff --git a/docs/tutorials/01_MelusinePipeline.md → tmp_docs/tutorials/01_MelusinePipeline.md b/docs/tutorials/01_MelusinePipeline.md → tmp_docs/tutorials/01_MelusinePipeline.md
diff --git a/docs/tutorials/02_MelusineTransformers.md → ...docs/tutorials/02_MelusineTransformers.md b/docs/tutorials/02_MelusineTransformers.md → ...docs/tutorials/02_MelusineTransformers.md
diff --git a/docs/tutorials/03_MelusineRegex.md → tmp_docs/tutorials/03_MelusineRegex.md b/docs/tutorials/03_MelusineRegex.md → tmp_docs/tutorials/03_MelusineRegex.md
diff --git a/docs/tutorials/04_UsingModels.md → tmp_docs/tutorials/04_UsingModels.md b/docs/tutorials/04_UsingModels.md → tmp_docs/tutorials/04_UsingModels.md
diff --git a/docs/tutorials/05a_MelusineDetectors.md → tmp_docs/tutorials/05a_MelusineDetectors.md b/docs/tutorials/05a_MelusineDetectors.md → tmp_docs/tutorials/05a_MelusineDetectors.md
diff --git a/...utorials/05b_MelusineDetectorsAdvanced.md → ...utorials/05b_MelusineDetectorsAdvanced.md b/...utorials/05b_MelusineDetectorsAdvanced.md → ...utorials/05b_MelusineDetectorsAdvanced.md
diff --git a/docs/tutorials/06_Configurations.md → tmp_docs/tutorials/06_Configurations.md b/docs/tutorials/06_Configurations.md → tmp_docs/tutorials/06_Configurations.md
diff --git a/docs/tutorials/07_BasicClassification.md → tmp_docs/tutorials/07_BasicClassification.md b/docs/tutorials/07_BasicClassification.md → tmp_docs/tutorials/07_BasicClassification.md
diff --git a/mkdocs.yml → tmp_mkdocs.yml b/mkdocs.yml → tmp_mkdocs.yml
@@ -44,7 +44,7 @@ nav:
 
 markdown_extensions:
   mdx_include:
-    base_path: docs
+    base_path: tmp_docs
   tables:
   admonition:
 #  pymdownx.details: