From 16f62a55545c557acdeb71e30cc63ab28f85dc7d Mon Sep 17 00:00:00 2001 From: Pierrick Rambaud Date: Sun, 27 Aug 2023 22:57:05 +0200 Subject: [PATCH 1/2] docs: move legacy documentation to the same folder --- docs/index.rst | 6 +----- docs/{ => legacy}/advanced_usage.rst | 0 docs/{ => legacy}/fruit-selector.vue | 0 docs/legacy/index.rst | 10 ++++++++++ docs/{ => legacy}/installation.rst | 0 docs/{ => legacy}/introduction.rst | 0 docs/{ => legacy}/showcase.py | 0 docs/{ => legacy}/template_usage.rst | 0 docs/{ => legacy}/usage.rst | 0 9 files changed, 11 insertions(+), 5 deletions(-) rename docs/{ => legacy}/advanced_usage.rst (100%) rename docs/{ => legacy}/fruit-selector.vue (100%) create mode 100644 docs/legacy/index.rst rename docs/{ => legacy}/installation.rst (100%) rename docs/{ => legacy}/introduction.rst (100%) rename docs/{ => legacy}/showcase.py (100%) rename docs/{ => legacy}/template_usage.rst (100%) rename docs/{ => legacy}/usage.rst (100%) diff --git a/docs/index.rst b/docs/index.rst index 113fb406..4b863e6d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,4 @@ ipyvuetify: Jupyter widgets based on Vuetify UI components .. toctree:: - introduction - installation - usage - advanced_usage - template_usage + legacy/index diff --git a/docs/advanced_usage.rst b/docs/legacy/advanced_usage.rst similarity index 100% rename from docs/advanced_usage.rst rename to docs/legacy/advanced_usage.rst diff --git a/docs/fruit-selector.vue b/docs/legacy/fruit-selector.vue similarity index 100% rename from docs/fruit-selector.vue rename to docs/legacy/fruit-selector.vue diff --git a/docs/legacy/index.rst b/docs/legacy/index.rst new file mode 100644 index 00000000..908d44b1 --- /dev/null +++ b/docs/legacy/index.rst @@ -0,0 +1,10 @@ +Legacy documentation +==================== + +.. toctree:: + + introduction + installation + usage + advanced_usage + template_usage diff --git a/docs/installation.rst b/docs/legacy/installation.rst similarity index 100% rename from docs/installation.rst rename to docs/legacy/installation.rst diff --git a/docs/introduction.rst b/docs/legacy/introduction.rst similarity index 100% rename from docs/introduction.rst rename to docs/legacy/introduction.rst diff --git a/docs/showcase.py b/docs/legacy/showcase.py similarity index 100% rename from docs/showcase.py rename to docs/legacy/showcase.py diff --git a/docs/template_usage.rst b/docs/legacy/template_usage.rst similarity index 100% rename from docs/template_usage.rst rename to docs/legacy/template_usage.rst diff --git a/docs/usage.rst b/docs/legacy/usage.rst similarity index 100% rename from docs/usage.rst rename to docs/legacy/usage.rst From 03432c2e348a7341641ea24fd5abe07933ac8969 Mon Sep 17 00:00:00 2001 From: Pierrick Rambaud Date: Sun, 27 Aug 2023 23:25:30 +0200 Subject: [PATCH 2/2] docs: propose new toctree --- docs/advance/index.rst | 8 ++++++++ docs/gallery/index.rst | 4 ++++ docs/index.rst | 4 ++++ docs/usage/authors | 2 ++ docs/usage/contributing.rst | 2 ++ docs/usage/index.rst | 10 ++++++++++ docs/usage/installation.rst | 2 ++ docs/usage/license.rst | 2 ++ docs/usage/tutorial.rst | 2 ++ 9 files changed, 36 insertions(+) create mode 100644 docs/advance/index.rst create mode 100644 docs/gallery/index.rst create mode 100644 docs/usage/authors create mode 100644 docs/usage/contributing.rst create mode 100644 docs/usage/index.rst create mode 100644 docs/usage/installation.rst create mode 100644 docs/usage/license.rst create mode 100644 docs/usage/tutorial.rst diff --git a/docs/advance/index.rst b/docs/advance/index.rst new file mode 100644 index 00000000..fcf80d36 --- /dev/null +++ b/docs/advance/index.rst @@ -0,0 +1,8 @@ +Advance usage +============= + +.. toctree:: + :caption: Advanced usage + +.. toctree:: + :caption: Example from the community \ No newline at end of file diff --git a/docs/gallery/index.rst b/docs/gallery/index.rst new file mode 100644 index 00000000..480a6a1e --- /dev/null +++ b/docs/gallery/index.rst @@ -0,0 +1,4 @@ +Gallery +======= + +To be filled with 1 page per widget. An auto-generated script will generate missing pages and then community of users will fill them with meaningful example. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 4b863e6d..90b9f317 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,4 +3,8 @@ ipyvuetify: Jupyter widgets based on Vuetify UI components .. toctree:: + usage/index + gallery/index + advance/index legacy/index + diff --git a/docs/usage/authors b/docs/usage/authors new file mode 100644 index 00000000..76330948 --- /dev/null +++ b/docs/usage/authors @@ -0,0 +1,2 @@ +Authors +======= \ No newline at end of file diff --git a/docs/usage/contributing.rst b/docs/usage/contributing.rst new file mode 100644 index 00000000..7cd6796e --- /dev/null +++ b/docs/usage/contributing.rst @@ -0,0 +1,2 @@ +Contribute +========== \ No newline at end of file diff --git a/docs/usage/index.rst b/docs/usage/index.rst new file mode 100644 index 00000000..98d427d7 --- /dev/null +++ b/docs/usage/index.rst @@ -0,0 +1,10 @@ +Getting started +=============== + +.. toctree:: + + installation + tutorial + contributing + license + authors \ No newline at end of file diff --git a/docs/usage/installation.rst b/docs/usage/installation.rst new file mode 100644 index 00000000..d0be4636 --- /dev/null +++ b/docs/usage/installation.rst @@ -0,0 +1,2 @@ +installation +============ \ No newline at end of file diff --git a/docs/usage/license.rst b/docs/usage/license.rst new file mode 100644 index 00000000..02148442 --- /dev/null +++ b/docs/usage/license.rst @@ -0,0 +1,2 @@ +license +======= \ No newline at end of file diff --git a/docs/usage/tutorial.rst b/docs/usage/tutorial.rst new file mode 100644 index 00000000..56128888 --- /dev/null +++ b/docs/usage/tutorial.rst @@ -0,0 +1,2 @@ +User guide +========== \ No newline at end of file