From ca779f8e101c58f85219d5e4bf6b0c268f1dd0bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonathan-David=20Schr=C3=B6der?= Date: Fri, 9 Apr 2021 14:41:22 +0200 Subject: [PATCH 1/2] #91 docs:adding cookbook page with intro in TOC --- docs/cookbook.rst | 26 ++++++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 27 insertions(+) create mode 100644 docs/cookbook.rst diff --git a/docs/cookbook.rst b/docs/cookbook.rst new file mode 100644 index 00000000..d2a35d9b --- /dev/null +++ b/docs/cookbook.rst @@ -0,0 +1,26 @@ +Cookbook for G'MIC beginners +============================ + +This cookbook is intended for newcomers to the G'MIC language. It takes you by the hand step by step, starting from your Python (optionnally Numpy, Scipy..) language skills and making you learn the G'MIC image processing language the easy way a smooth methodology. ``gmic-py`` allows to you evaluate G'MIC expressions and scripts easily, but breaking the walls of the G'MIC syntax is key for newcomers to leverage the power of the G'MIC engine. + +The progression of this cookbook follows more or less closely five gmic.eu website's articles (`Basics `, `Images `, `Selections and Command Decorations `, `Images have edges - Now What? `, `Conjuring Images out of the Aether and Other Generators `). It was thought of originally in `this pixls.us community discussion `. + +Basics +########### +TODO + +Images +######## +TODO + +Selections and Command Decorations +################################## +TODO + +Images have Edges - Now What? +############################# +TODO + +Conjuring Images out of the Aether and Other Generators +######################################################## +TODO diff --git a/docs/index.rst b/docs/index.rst index cc4f136e..f5a67927 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,6 +25,7 @@ Head over to the :doc:`gettingstarted` section for examples. installing gettingstarted + cookbook tutorials numpy PIL From 8f95facf6483aff6e4f4be6c4ef8669d1d9e6527 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonathan-David=20Schr=C3=B6der?= Date: Fri, 9 Apr 2021 15:31:18 +0200 Subject: [PATCH 2/2] #91 fixing cookbook links syntax, disabling tutorials.rst rendering --- {docs => DISABLED_DOC}/tutorials.rst | 0 docs/cookbook.rst | 2 +- docs/index.rst | 1 - 3 files changed, 1 insertion(+), 2 deletions(-) rename {docs => DISABLED_DOC}/tutorials.rst (100%) diff --git a/docs/tutorials.rst b/DISABLED_DOC/tutorials.rst similarity index 100% rename from docs/tutorials.rst rename to DISABLED_DOC/tutorials.rst diff --git a/docs/cookbook.rst b/docs/cookbook.rst index d2a35d9b..cb7066c2 100644 --- a/docs/cookbook.rst +++ b/docs/cookbook.rst @@ -3,7 +3,7 @@ Cookbook for G'MIC beginners This cookbook is intended for newcomers to the G'MIC language. It takes you by the hand step by step, starting from your Python (optionnally Numpy, Scipy..) language skills and making you learn the G'MIC image processing language the easy way a smooth methodology. ``gmic-py`` allows to you evaluate G'MIC expressions and scripts easily, but breaking the walls of the G'MIC syntax is key for newcomers to leverage the power of the G'MIC engine. -The progression of this cookbook follows more or less closely five gmic.eu website's articles (`Basics `, `Images `, `Selections and Command Decorations `, `Images have edges - Now What? `, `Conjuring Images out of the Aether and Other Generators `). It was thought of originally in `this pixls.us community discussion `. +The progression of this cookbook follows more or less closely five gmic.eu website's articles (`Basics `_, `Images `_, `Selections and Command Decorations `_, `Images have edges - Now What? `_, `Conjuring Images out of the Aether and Other Generators `_). It was thought of originally in `this pixls.us community discussion `_. Basics ########### diff --git a/docs/index.rst b/docs/index.rst index f5a67927..7fe61609 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,7 +26,6 @@ Head over to the :doc:`gettingstarted` section for examples. installing gettingstarted cookbook - tutorials numpy PIL skimage