Add README to plugins

jupyter-server · Feb 16, 2022 · 38df6af · 38df6af
1 parent e7b07c9
commit 38df6af
Show file tree

Hide file tree

Showing 18 changed files with 54 additions and 0 deletions.
diff --git a/plugins/auth/README.md b/plugins/auth/README.md
@@ -0,0 +1,3 @@
+# fps-auth
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing authentication.
diff --git a/plugins/auth/setup.cfg b/plugins/auth/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_auth
 version = attr: fps_auth.__version__
+description = An FPS plugin implementing authentication
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True

diff --git a/plugins/contents/README.md b/plugins/contents/README.md
@@ -0,0 +1,3 @@
+# fps-contents
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing the contents API.
diff --git a/plugins/contents/setup.cfg b/plugins/contents/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_contents
 version = attr: fps_contents.__version__
+description = An FPS plugin implementing the contents API
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True

diff --git a/plugins/jupyterlab/README.md b/plugins/jupyterlab/README.md
@@ -0,0 +1,3 @@
+# fps-jupyterlab
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing the JupyterLab API.
diff --git a/plugins/jupyterlab/setup.cfg b/plugins/jupyterlab/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_jupyterlab
 version = attr: fps_jupyterlab.__version__
+description = An FPS plugin implementing the JupyterLab API
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True

diff --git a/plugins/kernels/README.md b/plugins/kernels/README.md
@@ -0,0 +1,3 @@
+# fps-kernels
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing the kernels API.
diff --git a/plugins/kernels/setup.cfg b/plugins/kernels/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_kernels
 version = attr: fps_kernels.__version__
+description = An FPS plugin implementing the kernels API
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True

diff --git a/plugins/lab/README.md b/plugins/lab/README.md
@@ -0,0 +1,3 @@
+# fps-lab
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing the JupyterLab/RetroLab API.
diff --git a/plugins/lab/setup.cfg b/plugins/lab/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_lab
 version = attr: fps_lab.__version__
+description = An FPS plugin implementing the JupyterLab/RetroLab API
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True

diff --git a/plugins/login/README.md b/plugins/login/README.md
@@ -0,0 +1,3 @@
+# fps-login
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing the login API.
diff --git a/plugins/login/setup.cfg b/plugins/login/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_login
 version = attr: fps_login.__version__
+description = An FPS plugin implementing the login API
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True

diff --git a/plugins/retrolab/README.md b/plugins/retrolab/README.md
@@ -0,0 +1,3 @@
+# fps-login
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing the RetroLab API.
diff --git a/plugins/retrolab/setup.cfg b/plugins/retrolab/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_retrolab
 version = attr: fps_retrolab.__version__
+description = An FPS plugin implementing the RetroLab API
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True

diff --git a/plugins/terminals/README.md b/plugins/terminals/README.md
@@ -0,0 +1,3 @@
+# fps-terminals
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing the terminals API.
diff --git a/plugins/terminals/setup.cfg b/plugins/terminals/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_terminals
 version = attr: fps_terminals.__version__
+description = An FPS plugin implementing the terminals API
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True

diff --git a/plugins/yjs/README.md b/plugins/yjs/README.md
@@ -0,0 +1,3 @@
+# fps-yjs
+
+An [FPS](https://github.com/jupyter-server/fps) plugin implementing the Yjs API.
diff --git a/plugins/yjs/setup.cfg b/plugins/yjs/setup.cfg
@@ -1,6 +1,9 @@
 [metadata]
 name = fps_yjs
 version = attr: fps_yjs.__version__
+description = An FPS plugin implementing the Yjs API
+long_description = file: README.md
+long_description_content_type = text/markdown
 
 [options]
 include_package_data = True