Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more overview info on docs front page #3488

Merged
merged 1 commit into from
Jun 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@

master_doc = 'index'
project = 'Jupyter Widgets'
copyright = '2017-2021 Project Jupyter'
copyright = '2017-2022 Project Jupyter'
author = 'Jupyter Team'

language = None
language = "en"
exclude_patterns = [
'**.ipynb_checkpoints',
'examples.md',
Expand Down
4 changes: 4 additions & 0 deletions docs/source/dev_install.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Developer Install

The core Jupyter Widgets packages are developed in the
[https://github.com/jupyter-widgets/ipywidgets](https://github.com/jupyter-widgets/ipywidgets) git repository.


## Prerequisites

To install ipywidgets from git, you will need:
Expand Down
15 changes: 0 additions & 15 deletions docs/source/developer_docs.rst

This file was deleted.

66 changes: 55 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,67 @@
ipywidgets
==========
Jupyter Widgets
===============

.. only:: html

:Release: |release|
:Date: |today|

**ipywidgets**, also known as jupyter-widgets or simply widgets, are
`interactive HTML widgets <https://github.com/jupyter-widgets/ipywidgets/blob/master/docs/source/examples/Index.ipynb>`_
for Jupyter notebooks and the IPython kernel.
Jupyter Widgets are `interactive browser controls
<https://github.com/jupyter-widgets/ipywidgets/blob/master/docs/source/examples/Index.ipynb>`_
for Jupyter notebooks. Examples include:
- Basic form controls like sliders, checkboxes, text inputs
- Container controls like tabs, accordions, horizontal and vertical layout boxes, grid layouts
- Advanced controls like maps, 2d and 3d visualizations, datagrids, and more

Notebooks come alive when interactive widgets are used. Users gain control of
their data and can visualize changes in the data.
Notebooks come alive when interactive widgets are used. Users can visualize and
manipulate their data in intuitive and easy ways. Researchers can easily see
how changing inputs to a model impact the results. Scientists can share
interactive results with graphical user interfaces that others can play with
without seeing code. Exploring, learning, and sharing becomes a fun immersive
experience.

Learning becomes an immersive, fun experience. Researchers can easily see
how changing inputs to a model impact the results. We hope you will add
ipywidgets to your notebooks, and we're here to help you get started.
.. todo: Add screenshot

Core Jupyter Widgets
--------------------

Jupyter Widgets is primarily a framework to provide interactive controls (see
:doc:`examples/Widget Basics` for more information). The ``ipywidgets`` package
also provides a basic, lightweight set of core form controls that *use* this
framework. These included controls include a text area, text box, select and
multiselect controls, checkbox, sliders, tab panels, grid layout, etc.

The framework for building rich interactive objects is the foremost purpose of
the Jupyter Widgets project, and the set of included core form controls is
purposefully kept small and self-contained. We encourage and support a robust
ecosystem of packages built on top of the Jupyter Widgets framework to provide
more complicated interactive objects, such as maps, 2d and 3d visualizations, or
other form control systems built on a variety of popular Javascript frameworks
such as Material or Vue.

See the `Jupyter Widgets wiki page
<https://github.com/jupyter/jupyter/wiki/Jupyter-Widgets>`_ for more information
about custom widget packages built on top of the Jupyter Widgets framework.

Jupyter Widgets components
--------------------------

The Jupyter Widgets framework has several components:

1. A package in the kernel to provide an interface for widgets. The
``ipywidgets`` Python package provides Jupyter Widgets for the IPython
kernel. Other kernels may also provide Jupyter Widgets support.
2. An extension for the browser Jupyter frontend to manage Jupyter Widgets.
Installing ``ipywidgets`` automatically installs extensions for JupyterLab
and Jupyter Notebook (the ``jupyterlab-widgets`` and ``widgetsnbextension``
packages). The Jupyter Widgets project also maintains a plain HTML interface
for embedding Jupyter Widgets on a webpage, and many other frontends support
Jupyter Widgets.

See the `Jupyter Widgets wiki
page <https://github.com/jupyter/jupyter/wiki/Jupyter-Widgets>`_ for more
information from the community about kernels and frontends that support Jupyter Widgets, as well as
some custom widget packages built on top of the Jupyter Widgets framework.

.. toctree::
:caption: User Guide
Expand Down Expand Up @@ -46,7 +91,6 @@ ipywidgets to your notebooks, and we're here to help you get started.
:caption: Developer Guide
:maxdepth: 1

developer_docs
dev_install.md
dev_testing.md
dev_docs.md
Expand Down