[doc] Add notebook and copy button in code

.github/workflows/build.yml

@@ -45,6 +45,7 @@ jobs:
         python3-pip
         python3-sphinx
         python3-sphinx-rtd-theme 
+        python3-sphinx-copybutton
         python3-myst-parser &&
         pip3 install linkify-it-py 
 

doc/C2pyMagicDemo.ipynb

@@ -0,0 +1,66 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "eb187f68-7c62-4561-89a4-d8f0d10c2f32",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%load_ext clair.c2py_magic"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7f1865b8-2ff3-459b-806b-58a21dbb124b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%c2py \n",
+    "int add(int i, int j) { \n",
+    " return i+j;\n",
+    "}\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2a36f64c-0a85-4d83-880e-1bcd2fe6d75d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(add(2))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4367c72b-ab5c-42b3-8df5-54d9872d7213",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

doc/conf.py.in

@@ -17,10 +17,14 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.viewcode',
               'sphinx.ext.autosummary',
               'sphinx.ext.githubpages',
+              'sphinx_copybutton',
               # 'nbsphinx',
                'myst_parser',
               ]
 
+# Copy button options
+copybutton_exclude = '.linenos, .gp'
+
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 

doc/gettingstarted.rst

@@ -10,7 +10,6 @@ Let us begin with a simple example in file `my_module.cpp`.
 
 .. literalinclude:: examples/gs1.cpp
    :language: cpp
-   :linenos:
 
 We just compile the C++ file with `clang` using the ``clair`` plugin as 
 

doc/install_packages.rst

@@ -14,6 +14,7 @@ Experimental packages of ``c2py`` and ``clair`` are::
 
 They are built from source from the GitHub parcollet/ccq repository.
 
+
 .. note::
 
    To use the plugin as in the example below, 
@@ -24,5 +25,12 @@ They are built from source from the GitHub parcollet/ccq repository.
    for clang to find its plugins in brew directory as in the documentation examples.
    Alternatively, you can provide the full path to the plugin.
    This setup is not necessary to use the CMake targets.
-
+
+Uninstalling
+............
+
+In order to uninstall all formulas from the `parcollet/ccq` tap, you can use::
+
+        brew uninstall `brew list --full-name -1|grep ccq`
+