From b9d8dab364b9a2144e7690ea1121511056b2241a Mon Sep 17 00:00:00 2001 From: ThijsVroegh Date: Fri, 21 Jun 2024 14:58:24 +0200 Subject: [PATCH] restructure documentation and include missing information on installment and elements widgets --- doc/index.rst | 19 ++++++++++++++++--- doc/widgets.json | 9 ++++++++- doc/widgets/contact.md | 15 +++++++++++++++ doc/widgets/knownissues.md | 21 +++++++++++++++++++++ doc/widgets/usage.md | 6 ++++++ 5 files changed, 66 insertions(+), 4 deletions(-) create mode 100644 doc/widgets/contact.md create mode 100644 doc/widgets/knownissues.md create mode 100644 doc/widgets/usage.md diff --git a/doc/index.rst b/doc/index.rst index 3fe932a..b7e4872 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -19,12 +19,25 @@ Widgets ------- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + :caption: Getting Started - widgets/actoranalysis + widgets/install + usage + known issues + +.. toctree:: + :maxdepth: 2 + :caption: Widgets + widgets/actionanalysis - widgets/settinganalysis + widgets/actoranalysis + widgets/elements widgets/narrativenetwork + widgets/settinganalysis + + + Indices and tables ================== diff --git a/doc/widgets.json b/doc/widgets.json index f86e1c2..8d54abc 100644 --- a/doc/widgets.json +++ b/doc/widgets.json @@ -2,7 +2,14 @@ [ "Orange Story Navigator", [ - { + { + "text": "How to install the widget", + "doc": "widgets/install.md", + "icon": "../orangecontrib/storynavigation/widgets/images/storynavigator_logo.png", + "background": "#C0FF97", + "keywords": ["install", "Orange", "installation","Add-on"] + }, + { "text": "Actor Analysis", "doc": "widgets/actoranalysis.md", "icon": "../orangecontrib/storynavigation/widgets/icons/actor_analysis_icon.png", diff --git a/doc/widgets/contact.md b/doc/widgets/contact.md new file mode 100644 index 0000000..7ef4009 --- /dev/null +++ b/doc/widgets/contact.md @@ -0,0 +1,15 @@ +Known Issues +======= +![](../../doc/widgets/images/storynavigator_logo.png) + + +For questions, suggestions, etc you contact us as follows: + +**1** + +Lead Applicant information + + +**2** + +eScience? \ No newline at end of file diff --git a/doc/widgets/knownissues.md b/doc/widgets/knownissues.md new file mode 100644 index 0000000..2f18c33 --- /dev/null +++ b/doc/widgets/knownissues.md @@ -0,0 +1,21 @@ +Known Issues +======= +![](../../doc/widgets/images/storynavigator_logo.png) + + +The following is a list of known issues as part of working with the Orange3 StoryNavigator Add-on: + +**1** + +..... + + +**2** + +...... + +**3** + +...... + +**This list of issues can be further updated in the future.** \ No newline at end of file diff --git a/doc/widgets/usage.md b/doc/widgets/usage.md new file mode 100644 index 0000000..db964f6 --- /dev/null +++ b/doc/widgets/usage.md @@ -0,0 +1,6 @@ +How to enable StoryNavigator in Orange +======= +![](../../doc/widgets/images/storynavigator_logo.png) + + +Coming soon \ No newline at end of file