Starting NORTH docs (#197)

Co-authored-by: mkuehbach <markus.kuehbach@physik.hu-berlin.de>
Co-authored-by: lukaspie <lukaspie@github.com>
Co-authored-by: Markus Kühbach <mkuehbach@users.noreply.github.com>
Co-authored-by: RubelMozumder <32923026+RubelMozumder@users.noreply.github.com>

Author: 5 people

docs/explanation/north.md

@@ -59,10 +59,12 @@ This architecture allows plugin developers to freely choose a suitable granulari
 
 Plugin entry points represent different types of customizations that can be added to a NOMAD installation. The following plugin entry point types are currently supported:
 
+- [Actions](../howto/plugins/types/actions.md)
 - [APIs](../howto/plugins/types/apis.md)
 - [Apps](../howto/plugins/types/apps.md)
 - [Example uploads](../howto/plugins/types/example_uploads.md)
 - [Normalizers](../howto/plugins/types/normalizers.md)
+- [NORTH tools](../howto/plugins/types/north_tools.md)
 - [Parsers](../howto/plugins/types/parsers.md)
 - [Schema packages](../howto/plugins/types/schema_packages.md)
 

docs/explanation/plugin_system.md

@@ -60,6 +60,7 @@ NOMAD plugins are connect with the core software via "entry points". There are v
 - [Apps](plugins/types/apps.md)
 - [Example uploads](plugins/types/example_uploads.md)
 - [Normalizers](plugins/types/normalizers.md)
+- [NORTH tools](plugins/types/north_tools.md)
 - [Parsers](plugins/types/parsers.md)
 - [Schema packages](plugins/types/schema_packages.md)
 

docs/howto/overview.md

@@ -9,6 +9,7 @@ A single Python plugin package can contain multiple [plugin entry points](../../
 - [Apps](./types/apps.md)
 - [Example uploads](./types/example_uploads.md)
 - [Normalizers](./types/normalizers.md)
+- [NORTH tools](./types/north_tools.md)
 - [Parsers](./types/parsers.md)
 - [Schema packages](./types/schema_packages.md)
 

docs/howto/plugins/plugins.md

@@ -15,6 +15,7 @@ This is a list of the available plugin entry point configuration models.
 {{ pydantic_model('nomad.config.models.plugins.AppEntryPoint') }}
 {{ pydantic_model('nomad.config.models.plugins.ExampleUploadEntryPoint') }}
 {{ pydantic_model('nomad.config.models.plugins.NormalizerEntryPoint') }}
+{{ pydantic_model('nomad.config.models.plugins.NorthToolEntryPoint') }}
 {{ pydantic_model('nomad.config.models.plugins.ParserEntryPoint') }}
 {{ pydantic_model('nomad.config.models.plugins.SchemaPackageEntryPoint') }}
 

docs/howto/plugins/types/north_tools.md

@@ -44,6 +44,7 @@ nav:
               - Apps: howto/plugins/types/apps.md
               - Example uploads: howto/plugins/types/example_uploads.md
               - Normalizers: howto/plugins/types/normalizers.md
+              - NORTH tools: howto/plugins/types/north_tools.md
               - Parsers: howto/plugins/types/parsers.md
               - Schemas: howto/plugins/types/schema_packages.md
           - Built-in tools:
@@ -95,6 +96,7 @@ nav:
       - Workflows: explanation/workflows.md
       - Plugins: explanation/plugin_system.md
       - Federation and Oasis: explanation/oasis.md
+      - NORTH: explanation/north.md
   - Reference:
       # - Overview: reference/overview.md # TODO
       # - reference/metainfo.md # TODO This file no longer exists ... was it lost somehow?
@@ -140,9 +142,9 @@ markdown_extensions:
       permalink: True
   - pymdownx.arithmatex:
       generic: true
-  - pymdownx.emoji: # TODO make sure this isn't used!!
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  # - pymdownx.emoji: # TODO make sure this isn't used!!
+  #     emoji_index: !!python/name:material.extensions.emoji.twemoji
+  #     emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.superfences:
       custom_fences:
         - name: mermaid

docs/reference/plugins.md

@@ -14,7 +14,7 @@ dependencies = [
     'mkdocs-material',
     'mkdocs-redirects',
     "mkdocs",
-    "nomad-lab[infrastructure]>=1.3.18.dev89",
+    "nomad-lab[infrastructure]>=1.4.1.dev223",
     "pydantic>=2.0",
     "regex",
 ]