minor updates to the mkdocstrings config (#1503)

microsoft · Jan 1, 2025 · c01f0bd · c01f0bd
1 parent bed2979
commit c01f0bd
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 16 deletions.
diff --git a/docs/api/analyzer_python.md b/docs/api/analyzer_python.md
@@ -14,15 +14,15 @@
 ::: presidio_analyzer.recognizer_result.RecognizerResult
     handler: python
 
-## Batch
+## Batch modules
 
 ::: presidio_analyzer.batch_analyzer_engine.BatchAnalyzerEngine
     handler: python
 
 ::: presidio_analyzer.dict_analyzer_result.DictAnalyzerResult
     handler: python
 
-## Recognizers and patters
+## Recognizers and patterns
 
 ::: presidio_analyzer.entity_recognizer.EntityRecognizer
     handler: python
@@ -39,31 +39,31 @@
 ::: presidio_analyzer.remote_recognizer.RemoteRecognizer
     handler: python
 
-## Misc
-
-::: presidio_analyzer.analyzer_request.AnalyzerRequest
-    handler: python
-
-::: presidio_analyzer.analyzer_utils.PresidioAnalyzerUtils
-    handler: python
-
-## Recognizer registry
+## Recognizer registry modules
 
 ::: presidio_analyzer.recognizer_registry.RecognizerRegistry
     handler: python
 
 ::: presidio_analyzer.recognizer_registry.RecognizerRegistryProvider
     handler: python
 
-## Context awareness
+## Context awareness modules
 
 ::: presidio_analyzer.context_aware_enhancers
 
-## NLP Engine classes
+## NLP Engine modules
 
 ::: presidio_analyzer.nlp_engine
     handler: python
 
 ## Predefined Recognizers
 
 ::: presidio_analyzer.predefined_recognizers
+
+## Misc
+
+::: presidio_analyzer.analyzer_request.AnalyzerRequest
+    handler: python
+
+::: presidio_analyzer.analyzer_utils.PresidioAnalyzerUtils
+    handler: python
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -165,7 +165,7 @@ plugins:
             docstring_style: sphinx
             docstring_section_style: spacy
             show_root_heading: true
-            show_submodules: true
+            show_submodules: false
             show_bases: true
             merge_init_into_class: false
             group_by_category: false
@@ -193,6 +193,8 @@ extra:
       link: https://hub.docker.com/_/microsoft-presidio
     - icon: fontawesome/solid/envelope
       link: mailto:[email protected]
+    - icon: fontawesome/solid/meteor
+      link: https://huggingface.co/spaces/presidio/presidio_demo
 
 markdown_extensions:
   - meta

diff --git a/presidio-analyzer/presidio_analyzer/context_aware_enhancers/__init__.py b/presidio-analyzer/presidio_analyzer/context_aware_enhancers/__init__.py
@@ -1,5 +1,4 @@
-"""Recognizer registry init."""
-
+"""Context awareness modules."""
 from .context_aware_enhancer import ContextAwareEnhancer
 from .lemma_context_aware_enhancer import LemmaContextAwareEnhancer