diff --git a/docs/_static/custom.css b/docs/_static/custom.css index e342737b..8744437f 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -6,6 +6,30 @@ div.jupyter_container.docutils { padding: 0.4em; } +/* Hero from Homepage */ +#hero { + display: flex; + flex-direction: row; + min-height: min(calc(80vh), 1100px); +} + +#hero img { + border: 1px solid var(--pst-color-border); + border-radius: 0.25em; +} + +#hero-left { + max-width: 476px; + width: 40%; + margin: auto 1em; +} + +#hero-right { + min-width: 476px; + width: 60%; + margin: auto 1em; +} + /* customize primary color to align with the vuetify website */ html[data-theme="light"] { --pst-color-primary: #1867c0; diff --git a/docs/conf.py b/docs/conf.py index fba31c23..c623b2e2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ # -- General configuration --------------------------------------------------- -extensions = ["jupyter_sphinx"] +extensions = ["jupyter_sphinx", "sphinx_rtd_theme", "sphinx_design"] templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] @@ -49,6 +49,9 @@ "icon": "fa-brands fa-python", }, ], + "logo": { + "text": "ipyvuetify", + }, } html_context = { "github_user": "widgetti", diff --git a/docs/images/dark-demo.gif b/docs/images/dark-demo.gif new file mode 100644 index 00000000..794127e0 Binary files /dev/null and b/docs/images/dark-demo.gif differ diff --git a/docs/images/light-demo.gif b/docs/images/light-demo.gif new file mode 100644 index 00000000..dc451dfb Binary files /dev/null and b/docs/images/light-demo.gif differ diff --git a/docs/index.rst b/docs/index.rst index 113fb406..fba7c6a9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,68 @@ +:html_theme.sidebar_secondary.remove: + +.. raw:: html + + + + ipyvuetify: Jupyter widgets based on Vuetify UI components ========================================================== +.. raw:: html + +
+
+ +IpyVuetify +---------- + +Jupyter widgets based on Vuetify UI components +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Ipyvuetify** is a widget library for making modern-looking GUIs in Jupyter notebooks (`classic `__, `lab `__, `lite `__) and dashboards (`Voilà `__, `Voici `__). Based on the `Vuetify UI `__ library, it extends the standard Jupyter widget library with additional widgets that are more customizable and composable. + +.. raw:: html + + + + +.. raw:: html + +
+
+ +.. image:: images/light-demo.gif + :class: only-light + +.. image:: images/dark-demo.gif + :class: only-dark + +.. raw:: html + +
+
+ .. toctree:: + :hidden: introduction installation diff --git a/pyproject.toml b/pyproject.toml index cf488624..5f4fe26c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,7 +41,13 @@ content-type = "text/markdown" [project.optional-dependencies] dev = ["nox", "pre-commit", "mypy"] test = ["pytest", "pytest-playwright", "nbformat<5.10", "jupyterlab<4", "solara[pytest]"] -doc = ["sphinx<7", "jupyter-sphinx", "ipykernel", "pydata-sphinx-theme"] +doc = [ + "sphinx<7", + "jupyter-sphinx", + "ipykernel", + "pydata-sphinx-theme", + "sphinx-design" +] [tool.setuptools] include-package-data = true