Merge pull request #329 from FAIRmat-NFDI/plugins-in-docs

Add plugins and links to individual docs to the main docs

Author: lukaspie

README.md

@@ -52,30 +52,6 @@ data into the NeXus standard and visualising the files content.
 # Documentation
 Documentation for the different tools can be found [here](https://fairmat-nfdi.github.io/pynxtools/).
 
-# Plugins
-There are a number of plugins available for pynxtools. These are extensions of pynxtools used for reading data of specific experimental techniques.
-- [**pynxtools-mpes**](https://github.com/FAIRmat-NFDI/pynxtools-mpes): A reader for multi-dimensional photoelectron spectroscopy data.
-- [**pynxtools-stm**](https://github.com/FAIRmat-NFDI/pynxtools-stm): A reader for scanning tunneling microscopy (SPM) and spectroscopy (STS) data.
-- [**pynxtools-xps**](https://github.com/FAIRmat-NFDI/pynxtools-xps): A reader for X-ray photoelectron spectroscopy (XPS) data.
-- [**pynxtools-apm**](https://github.com/FAIRmat-NFDI/pynxtools-apm): A reader for atom probe as well as related field ion microscopy data.
-- [**pynxtools-em**](https://github.com/FAIRmat-NFDI/pynxtools-em): A reader for electron microscopy data.
-- [**pynxtools-ellips**](https://github.com/FAIRmat-NFDI/pynxtools-ellips): A reader for ellipsometry data.
-
-Note that pynxtools-apm and pynxtools-em are currently refactored into pynxtools plugins.
-Until this refactoring will have become completed, users are advised to use the apm and em readers via pynxtools<=0.1.1.
-
-
-You can install each of the plugins together with `pynxtools` by passing the name of the plugin as an extra to the pip install call. For example, for the `pynxtools-mpes` plugin:
-```shell
-pip install pynxtools[mpes]
-```
-
-In addition, you can also install all of the `pynxtools` reader plugins which are maintained by FAIRmat by passing the `[convert]` extra to the pip install call:
-```shell
-pip install pynxtools[convert]
-```
-There is also a [cookiecutter template](https://github.com/FAIRmat-NFDI/pynxtools-plugin-template) available for creating your own pynxtools plugin.
-
 # Contributing
 
 ## Development install

docs/index.md

@@ -51,6 +51,8 @@ An introduction to NeXus and its design principles.
 
 ### Reference
 
+Within FAIRmat, we maintain a number of reader plugins for different experimental techniques. You can find more information [here](reference/plugins.md).
+
 [Here](reference/definitions.md), you find the detailed list of application definitions and base classes and their respective fields.
 
 Or go directly to the [official NIAC](https://manual.nexusformat.org/classes/index.html)
@@ -59,4 +61,4 @@ Or go directly to the [official NIAC](https://manual.nexusformat.org/classes/ind
 </div>
 </div>
 
-<h2>Project and community</h2>
+<h2>Project and community</h2>

docs/reference/plugins.md

@@ -0,0 +1,25 @@
+# Plugins
+There are a number of plugins available for pynxtools that are maintained within FAIRmat. These are extensions of pynxtools used for reading data of specific experimental techniques.
+
+- [**pynxtools-mpes**](https://github.com/FAIRmat-NFDI/pynxtools-mpes): A reader for multi-dimensional photoelectron spectroscopy data.
+- [**pynxtools-stm**](https://github.com/FAIRmat-NFDI/pynxtools-stm): A reader for scanning tunneling microscopy (SPM) and spectroscopy (STS) data.
+- [**pynxtools-xps**](https://github.com/FAIRmat-NFDI/pynxtools-xps): A reader for X-ray photoelectron spectroscopy (XPS) data. Documentation can be found [here](https://fairmat-nfdi.github.io/pynxtools-xps/).
+- [**pynxtools-apm**](https://github.com/FAIRmat-NFDI/pynxtools-apm): A reader for atom probe as well as related field ion microscopy data. Documentation can be found [here](https://fairmat-nfdi.github.io/pynxtools-apm/).
+- [**pynxtools-em**](https://github.com/FAIRmat-NFDI/pynxtools-em): A reader for electron microscopy data. Documentation can be found [here](https://fairmat-nfdi.github.io/pynxtools-em/).
+- [**pynxtools-ellips**](https://github.com/FAIRmat-NFDI/pynxtools-ellips): A reader for ellipsometry data. Documentation can be found [here](https://fairmat-nfdi.github.io/pynxtools-ellips/).
+
+## Installation
+
+You can install each of the plugins together with pynxtools by passing the name of the plugin as an extra to the pip install call. For example, for the pynxtools-mpes plugin:
+
+```
+pip install pynxtools[mpes]
+```
+
+In addition, you can also install all of the pynxtools reader plugins which are maintained by FAIRmat by passing the [convert] extra to the pip install call:
+
+```
+pip install pynxtools[convert]
+```
+
+There is also a [cookiecutter template](https://github.com/FAIRmat-NFDI/pynxtools-plugin-template) available for creating your own pynxtools plugin.

mkdocs.yaml

@@ -14,6 +14,7 @@ nav:
     - learn/nexus-primer.md
     - learn/multiple-appdefs.md
   - Reference:
+    - reference/plugins.md
     - reference/definitions.md
 theme:
   name: material