sphinx-panel-screenshot


Namesphinx-panel-screenshot JSON
Version 0.1.3 PyPI version JSON
download
home_pagehttps://github.com/Davide-sd/sphinx_panel_screenshot
SummaryA directive to include panel's screenshots into a Sphinx document
upload_time2022-12-02 14:54:18
maintainer
docs_urlNone
authorDavide Sandona
requires_python
licenseMIT License
keywords panel sphinx screenshot
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # sphinx_panel_screenshot

[![PyPI version](https://badge.fury.io/py/sphinx-panel-screenshot.svg)](https://badge.fury.io/py/sphinx-panel-screenshot)
[![Conda (channel only)](https://img.shields.io/conda/vn/davide_sd/sphinx_panel_screenshot?color=%2340BA12&label=conda%20package)](https://anaconda.org/Davide_sd/sphinx_panel_screenshot)
[![Documentation Status](https://readthedocs.org/projects/sphinx-panel-screenshot/badge/?version=latest)](https://sphinx-panel-screenshot.readthedocs.io/en/latest/?badge=latest)

A Sphinx directive for including the screenshot of an holoviz's panel widget
in a Sphinx document.

_**This package is based on [matplotlib's plot directive](https://matplotlib.org/stable/api/sphinxext_plot_directive_api.html).**_

## Install

```
pip install sphinx_panel_screenshot
```

or:

```
conda install -c davide_sd sphinx_panel_screenshot 
```

Take a look at the [Installation page](https://sphinx-panel-screenshot.readthedocs.io/en/latest/install.html)
to understand how to configure the extension to run on [readthedocs.org server](https://readthedocs.org).

## Usage

```python
.. panel-screenshot::

   floatslider = pn.widgets.FloatSlider(start=0, end=2, value=0.5,
   name="Float Slider")
   radiobutton_group = pn.widgets.RadioButtonGroup(
      name='Radio Button Group', options=['Biology', 'Chemistry', 'Physics'],
      button_type='success')
   radiobox_group = radio_group = pn.widgets.RadioBoxGroup(
      name='RadioBoxGroup', options=['Biology', 'Chemistry', 'Physics'], inline=True)
   select = pn.widgets.Select(name='Select',
      options=['Biology', 'Chemistry', 'Physics'])
   checkbutton_group = pn.widgets.CheckButtonGroup(name='Check Button Group',
      value=['Apple', 'Pear'],
      options=['Apple', 'Banana', 'Pear', 'Strawberry'])
   checkbox = pn.widgets.Checkbox(name='Checkbox')
   col = pn.Column(floatslider, radiobutton_group, radiobox_group, select, checkbutton_group, checkbox)
   col
```

<img src="https://raw.githubusercontent.com/Davide-sd/sphinx_panel_screenshot/master/imgs/screenshot-1.png">

Take a look at the [Examples page](https://sphinx-panel-screenshot.readthedocs.io/en/latest/examples/index.html)
to visualize the available customization options.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Davide-sd/sphinx_panel_screenshot",
    "name": "sphinx-panel-screenshot",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "panel sphinx screenshot",
    "author": "Davide Sandona",
    "author_email": "sandona.davide@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c4/18/8d07774a7be3193aa464cba8285b1e193f7490b29c4dbcb1467d6c605fa4/sphinx_panel_screenshot-0.1.3.tar.gz",
    "platform": null,
    "description": "# sphinx_panel_screenshot\n\n[![PyPI version](https://badge.fury.io/py/sphinx-panel-screenshot.svg)](https://badge.fury.io/py/sphinx-panel-screenshot)\n[![Conda (channel only)](https://img.shields.io/conda/vn/davide_sd/sphinx_panel_screenshot?color=%2340BA12&label=conda%20package)](https://anaconda.org/Davide_sd/sphinx_panel_screenshot)\n[![Documentation Status](https://readthedocs.org/projects/sphinx-panel-screenshot/badge/?version=latest)](https://sphinx-panel-screenshot.readthedocs.io/en/latest/?badge=latest)\n\nA Sphinx directive for including the screenshot of an holoviz's panel widget\nin a Sphinx document.\n\n_**This package is based on [matplotlib's plot directive](https://matplotlib.org/stable/api/sphinxext_plot_directive_api.html).**_\n\n## Install\n\n```\npip install sphinx_panel_screenshot\n```\n\nor:\n\n```\nconda install -c davide_sd sphinx_panel_screenshot \n```\n\nTake a look at the [Installation page](https://sphinx-panel-screenshot.readthedocs.io/en/latest/install.html)\nto understand how to configure the extension to run on [readthedocs.org server](https://readthedocs.org).\n\n## Usage\n\n```python\n.. panel-screenshot::\n\n   floatslider = pn.widgets.FloatSlider(start=0, end=2, value=0.5,\n   name=\"Float Slider\")\n   radiobutton_group = pn.widgets.RadioButtonGroup(\n      name='Radio Button Group', options=['Biology', 'Chemistry', 'Physics'],\n      button_type='success')\n   radiobox_group = radio_group = pn.widgets.RadioBoxGroup(\n      name='RadioBoxGroup', options=['Biology', 'Chemistry', 'Physics'], inline=True)\n   select = pn.widgets.Select(name='Select',\n      options=['Biology', 'Chemistry', 'Physics'])\n   checkbutton_group = pn.widgets.CheckButtonGroup(name='Check Button Group',\n      value=['Apple', 'Pear'],\n      options=['Apple', 'Banana', 'Pear', 'Strawberry'])\n   checkbox = pn.widgets.Checkbox(name='Checkbox')\n   col = pn.Column(floatslider, radiobutton_group, radiobox_group, select, checkbutton_group, checkbox)\n   col\n```\n\n<img src=\"https://raw.githubusercontent.com/Davide-sd/sphinx_panel_screenshot/master/imgs/screenshot-1.png\">\n\nTake a look at the [Examples page](https://sphinx-panel-screenshot.readthedocs.io/en/latest/examples/index.html)\nto visualize the available customization options.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "A directive to include panel's screenshots into a Sphinx document",
    "version": "0.1.3",
    "split_keywords": [
        "panel",
        "sphinx",
        "screenshot"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "284ede7d010f4891cff5d840b026d01e",
                "sha256": "b77403581f578fb0be8ce09c42133c748f7d06abde12e809d8ed2a22d24dfc29"
            },
            "downloads": -1,
            "filename": "sphinx_panel_screenshot-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "284ede7d010f4891cff5d840b026d01e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 13734,
            "upload_time": "2022-12-02T14:54:17",
            "upload_time_iso_8601": "2022-12-02T14:54:17.459036Z",
            "url": "https://files.pythonhosted.org/packages/ae/31/f0cab4a97ec38769ba53f4712ce69fcff0ada89862eb1ef8347ec2d8bf61/sphinx_panel_screenshot-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "4f1abec1e8a21f0b3f5a2c23d21d5264",
                "sha256": "dc435d4baa7363e8c0f6228f9e57bc5a43f70faa33fbe6b6034899b3decffd10"
            },
            "downloads": -1,
            "filename": "sphinx_panel_screenshot-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "4f1abec1e8a21f0b3f5a2c23d21d5264",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14091,
            "upload_time": "2022-12-02T14:54:18",
            "upload_time_iso_8601": "2022-12-02T14:54:18.847480Z",
            "url": "https://files.pythonhosted.org/packages/c4/18/8d07774a7be3193aa464cba8285b1e193f7490b29c4dbcb1467d6c605fa4/sphinx_panel_screenshot-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-02 14:54:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "Davide-sd",
    "github_project": "sphinx_panel_screenshot",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sphinx-panel-screenshot"
}
Davide Sandona
Elapsed time: 0.01397s