Skip to content

Commit 5cc6ba2

Browse files
committed
update documentation
1 parent cf38783 commit 5cc6ba2

3 files changed

Lines changed: 15 additions & 7 deletions

File tree

documentation/CP-plugins-documentation/_toc.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ parts:
66
- caption: Overview
77
chapters:
88
- file: overview
9+
- file: using_plugins
910
- file: supported_plugins
1011
- file: unsupported_plugins
11-
- caption: Technical Guides
12-
chapters:
13-
- file: Windows
14-
- file: Mac
12+
- file: contributing_plugins
13+
- file: troubleshooting
14+
- file: citing
15+
- file: versions
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Troubleshooting
2+
3+
| Problem | Solution |
4+
|---|-----|
5+
| After setting the CellProfiler Plugins folder, CellProfiler won't open and returns an `error: no commands supplied` in the terminal. | You have set the CellProfiler Plugins folder to the parent folder of the plugins repository (`CellProfiler-plugins`), not the folder that contains plugins (`CellProfiler-plugins/active_plugins`). In order to get it to open, remove `setup.py` from the folder. Change the CellProfiler Plugins path to the correct path and close CellProfiler. Return `setup.py` to the parent folder. |
6+
| No plugins are visible in the "Add Modules" panel in CellProfiler. | You have not properly set the plugins path. Go to `CellProfiler` => `Preferences` and set the path in the `CellProfiler plugins directory` to the `active_plugins` folder in the GitHub repository that you just cloned. Select `Save` at the bottom of the Preferences window. |
7+
| Some but not all plugins are visible in the in the "Add Modules" panel in CellProfiler. | Not-visible plugins have unmet dependencies. Follow [installation instructions](using_plugins.md) to install dependencies for plugins. |

documentation/CP-plugins-documentation/using_plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Alternatively, if you have code for plugins that are not in the CellProfiler-plu
3939

4040
3. **Set the plugins path in CellProfiler.**
4141
- Open CellProfiler.
42-
- Go to `CellProfiler` => `Preferences` and set the path in the `CellProfiler plugins directory` to the GitHub repository that you just cloned (or, if you didn't clone the whole repository, whatever location you have saved your plugins into).
42+
- Go to `CellProfiler` => `Preferences` and set the path in the `CellProfiler plugins directory` to the `active_plugins` folder in the GitHub repository that you just cloned (or, if you didn't clone the whole repository, whatever location you have saved your plugins into).
4343
- Select `Save` at the bottom of the Preferences window
4444
- Close CellProfiler and re-open it
4545

@@ -59,7 +59,7 @@ git clone https://github.com/CellProfiler/CellProfiler-plugins.git
5959

6060
3. **Set the plugins path in CellProfiler.**
6161
- Open CellProfiler.
62-
- Go to `CellProfiler` => `Preferences` and set the path in the `CellProfiler plugins directory` to the GitHub repository that you just cloned.
62+
- Go to `CellProfiler` => `Preferences` and set the path in the `CellProfiler plugins directory` to the `active_plugins` folder in the GitHub repository that you just cloned.
6363
- Select `Save` at the bottom of the Preferences window
6464
- Close CellProfiler
6565

@@ -89,7 +89,7 @@ git clone https://github.com/CellProfiler/CellProfiler-plugins.git
8989

9090
3. **Set the plugins path in CellProfiler.**
9191
- Open CellProfiler.
92-
- Go to `CellProfiler` => `Preferences` and set the path in the `CellProfiler plugins directory` to the GitHub repository that you just cloned.
92+
- Go to `CellProfiler` => `Preferences` and set the path in the `CellProfiler plugins directory` to the `active_plugins` folder in the GitHub repository that you just cloned.
9393
- Select `Save` at the bottom of the Preferences window
9494
- Close CellProfiler
9595

0 commit comments

Comments
 (0)