Skip to content

Make docs executable #1429

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.

Sign up for GitHub

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

Merged
martinRenou merged 1 commit into from
Jan 7, 2022
Merged

Make docs executable #1429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ dependencies:
- pandas
- bqplot
- sphinx_rtd_theme
- sphinx_thebe
- jupyter_sphinx
13 changes: 10 additions & 3 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'jupyter_sphinx',
'sphinx_thebe'
]

autosummary_generate = True
Expand All @@ -65,9 +66,6 @@

"""

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

Expand Down Expand Up @@ -98,6 +96,15 @@
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
htmlhelp_basename = 'bqplotdoc'

# -- Options for thebe ---------------------------------------------

thebe_config = {
"always_load": False,
"selector": "div.jupyter_cell",
"selector_output": "div.cell_output",
"repository_url": "https://github.com/bqplot/bqplot",
"repository_branch": "stable",
}

# -- Options for LaTeX output ---------------------------------------------

Expand Down
5 changes: 5 additions & 0 deletions docs/source/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Usage
=====

The following code examples are static, but you can make them executable and test bqplot
by clicking the following button:

.. thebe-button:: Click me!

Examples
--------

Expand Down