Script 'mail_helper' called by obssrc
Hello community,
here is the log from the commit of package python-nbsphinx for openSUSE:Factory
checked in at 2022-06-18 22:06:02
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-nbsphinx (Old)
and /work/SRC/openSUSE:Factory/.python-nbsphinx.new.1548 (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-nbsphinx"
Sat Jun 18 22:06:02 2022 rev:11 rq:983483 version:0.8.9
Changes:
--------
--- /work/SRC/openSUSE:Factory/python-nbsphinx/python-nbsphinx.changes
2022-02-27 22:44:16.706651106 +0100
+++
/work/SRC/openSUSE:Factory/.python-nbsphinx.new.1548/python-nbsphinx.changes
2022-06-18 22:06:05.479647710 +0200
@@ -1,0 +2,7 @@
+Fri Jun 17 18:17:32 UTC 2022 - Yogalakshmi Arunachalam <yarunacha...@suse.com>
+
+- Update to Version 0.8.9
+ * CSS: support tables in widgets
+ * Avoid empty "raw" directive
+
+-------------------------------------------------------------------
Old:
----
nbsphinx-0.8.8.tar.gz
New:
----
nbsphinx-0.8.9.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-nbsphinx.spec ++++++
--- /var/tmp/diff_new_pack.ZPQ07x/_old 2022-06-18 22:06:05.971648409 +0200
+++ /var/tmp/diff_new_pack.ZPQ07x/_new 2022-06-18 22:06:05.975648415 +0200
@@ -19,7 +19,7 @@
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
%define skip_python2 1
Name: python-nbsphinx
-Version: 0.8.8
+Version: 0.8.9
Release: 0
Summary: Jupyter Notebook Tools for Sphinx
License: MIT
@@ -33,7 +33,7 @@
BuildRequires: %{python_module nbformat}
BuildRequires: %{python_module setuptools}
BuildRequires: %{python_module sphinx_rtd_theme}
-BuildRequires: %{python_module traitlets}
+BuildRequires: %{python_module traitlets >= 5}
BuildRequires: fdupes
BuildRequires: python-rpm-macros
Requires: python-Jinja2
@@ -42,7 +42,7 @@
Requires: python-nbconvert
Requires: python-nbformat
Requires: python-sphinx_rtd_theme
-Requires: python-traitlets
+Requires: python-traitlets >= 5
Recommends: mathjax
Recommends: pandoc
Provides: python-jupyter_nbsphinx = %{version}
@@ -86,6 +86,6 @@
%license LICENSE
%{python_sitelib}/nbsphinx.py*
%pycache_only %{python_sitelib}/__pycache__/nbsphinx.*.py*
-%{python_sitelib}/nbsphinx-%{version}-py*.egg-info
+%{python_sitelib}/nbsphinx-%{version}*-info
%changelog
++++++ nbsphinx-0.8.8.tar.gz -> nbsphinx-0.8.9.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/.github/workflows/html-macos.yml
new/nbsphinx-0.8.9/.github/workflows/html-macos.yml
--- old/nbsphinx-0.8.8/.github/workflows/html-macos.yml 1970-01-01
01:00:00.000000000 +0100
+++ new/nbsphinx-0.8.9/.github/workflows/html-macos.yml 2022-04-10
15:35:02.000000000 +0200
@@ -0,0 +1,29 @@
+name: Build HTML on macOS
+on: [push, pull_request]
+jobs:
+ html-macos:
+ runs-on: macos-latest
+ steps:
+ - name: Clone repo
+ uses: actions/checkout@v2
+ with:
+ fetch-depth: 0
+ - name: Install pandoc
+ run: |
+ brew install pandoc
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3
+ - name: Double-check Python version
+ run: |
+ python --version
+ - name: Install Python package
+ run: |
+ python -m pip install .
+ - name: Install docs dependencies
+ run: |
+ python -m pip install -r doc/requirements.txt
+ - name: Build HTML
+ run: |
+ python -m sphinx -W --keep-going --color doc/ _build/html/
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/LICENSE new/nbsphinx-0.8.9/LICENSE
--- old/nbsphinx-0.8.8/LICENSE 2021-12-07 13:02:04.000000000 +0100
+++ new/nbsphinx-0.8.9/LICENSE 2022-06-04 20:24:56.000000000 +0200
@@ -1,4 +1,4 @@
-Copyright (c) 2015-2021 Matthias Geier
+Copyright (c) 2015-2022 Matthias Geier
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/NEWS.rst new/nbsphinx-0.8.9/NEWS.rst
--- old/nbsphinx-0.8.8/NEWS.rst 2021-12-31 13:24:53.000000000 +0100
+++ new/nbsphinx-0.8.9/NEWS.rst 2022-06-04 20:27:10.000000000 +0200
@@ -1,3 +1,10 @@
+Version 0.8.9 -- 2022-06-04 -- PyPI__ -- diff__
+ * CSS: support tables in widgets
+ * Avoid empty "raw" directive
+
+__ https://pypi.org/project/nbsphinx/0.8.9/
+__ https://github.com/spatialaudio/nbsphinx/compare/0.8.8...0.8.9
+
Version 0.8.8 -- 2021-12-31 -- PyPI__ -- diff__
* Support for the ``sphinx_codeautolink`` extension
* Basic support for the ``text`` builder
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/PKG-INFO new/nbsphinx-0.8.9/PKG-INFO
--- old/nbsphinx-0.8.8/PKG-INFO 2021-12-31 13:26:09.230423000 +0100
+++ new/nbsphinx-0.8.9/PKG-INFO 2022-06-04 20:28:44.205046400 +0200
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: nbsphinx
-Version: 0.8.8
+Version: 0.8.9
Summary: Jupyter Notebook Tools for Sphinx
Home-page: https://nbsphinx.readthedocs.io/
Author: Matthias Geier
@@ -55,5 +55,3 @@
.. _Sphinx: https://www.sphinx-doc.org/
.. _Jupyter Notebook: https://jupyter.org/
-
-
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/doc/code-cells.ipynb
new/nbsphinx-0.8.9/doc/code-cells.ipynb
--- old/nbsphinx-0.8.8/doc/code-cells.ipynb 2021-12-07 13:02:04.000000000
+0100
+++ new/nbsphinx-0.8.9/doc/code-cells.ipynb 2022-04-22 18:46:35.000000000
+0200
@@ -252,7 +252,7 @@
"metadata": {},
"outputs": [],
"source": [
- "Image(url='https://jupyter.org/assets/nav_logo.svg')"
+ "Image(url='https://jupyter.org/assets/homepage/main-logo.svg')"
]
},
{
@@ -310,8 +310,22 @@
"source": [
"### Plots\n",
"\n",
- "The output formats for Matplotlib plots can be customized.\n",
- "You'll need separate settings for the Jupyter Notebook application and
for `nbsphinx`.\n",
+ "The output formats for Matplotlib plots can be customized\n",
+ "via the IPython configuration file `ipython_kernel_config.py`.\n",
+ "This file can be either\n",
+ "in the directory where your notebook is located\n",
+ "(see the [ipython_kernel_config.py](ipython_kernel_config.py) in this
directory),\n",
+ "or in your profile directory\n",
+ "(typically `~/.ipython/profile_default/ipython_kernel_config.py`).\n",
+ "To find out your IPython profile directory, use this command:\n",
+ "\n",
+ " python3 -m IPython profile locate\n",
+ "\n",
+ "A local `ipython_kernel_config.py` in the notebook directory\n",
+ "also works on https://mybinder.org/.\n";,
+ "Alternatively, you can create a file with those settings in a file
named\n",
+ "`.ipython/profile_default/ipython_kernel_config.py` in your
repository.\n",
+ "\n",
"\n",
"If you want to use SVG images for Matplotlib plots,\n",
"add this line to your IPython configuration file:\n",
@@ -342,22 +356,10 @@
"For more details on these and other settings, have a look at\n",
"[Default Values for Matplotlib's \"inline\"
Backend](https://nbviewer.jupyter.org/github/mgeier/python-audio/blob/master/plotting/matplotlib-inline-defaults.ipynb).\n",
"\n",
- "The configuration file `ipython_kernel_config.py` can be either\n",
- "in the directory where your notebook is located\n",
- "(see the [ipython_kernel_config.py](ipython_kernel_config.py) in this
directory),\n",
- "or in your profile directory\n",
- "(typically `~/.ipython/profile_default/ipython_kernel_config.py`).\n",
- "To find out your IPython profile directory, use this command:\n",
- "\n",
- " python3 -m IPython profile locate\n",
- "\n",
- "A local `ipython_kernel_config.py` in the notebook directory\n",
- "also works on https://mybinder.org/.\n";,
- "Alternatively, you can create a file with those settings in a file
named\n",
- "`.ipython/profile_default/ipython_kernel_config.py` in your
repository.\n",
- "\n",
- "To get SVG and PDF plots for `nbsphinx`,\n",
- "use something like this in your `conf.py` file:\n",
+ "If you for some reason can't use a `ipython_kernel_config.py` file,\n",
+ "you can also change these settings with\n",
+ "[nbsphinx_execute_arguments](usage.ipynb#nbsphinx_execute_arguments)\n",
+ "in your `conf.py` file:\n",
"\n",
"```python\n",
"nbsphinx_execute_arguments = [\n",
@@ -555,6 +557,55 @@
"cell_type": "markdown",
"metadata": {},
"source": [
+ "### Markdown Content"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "from IPython.display import Markdown"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "md = Markdown(\"\"\"\n",
+ "# Markdown\n",
+ "\n",
+ "It *should* show up as **formatted** text\n",
+ "with things like [links] and images.\n",
+ "\n",
+ "[links]: https://jupyter.org/\n";,
+ "\n",
+ "\n",
+ "\n",
+ "## Markdown Extensions\n",
+ "\n",
+ "There might also be mathematical equations like\n",
+ "$a^2 + b^2 = c^2$\n",
+ "and even tables:\n",
+ "\n",
+ "A | B | A and B\n",
+ "------|-------|--------\n",
+ "False | False | False\n",
+ "True | False | False\n",
+ "False | True | False\n",
+ "True | True | True\n",
+ "\n",
+ "\"\"\")\n",
+ "md"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
"### YouTube Videos"
]
},
@@ -565,7 +616,7 @@
"outputs": [],
"source": [
"from IPython.display import YouTubeVideo\n",
- "YouTubeVideo('WAikxUGbomY')"
+ "YouTubeVideo('9_OIs49m56E')"
]
},
{
@@ -663,6 +714,22 @@
]
},
{
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "tabs = w.Tab()\n",
+ "for idx, obj in enumerate([df, fig, eq, i, md, slider]):\n",
+ " out = w.Output()\n",
+ " with out:\n",
+ " display(obj)\n",
+ " tabs.children += out,\n",
+ " tabs.set_title(idx, obj.__class__.__name__)\n",
+ "tabs"
+ ]
+ },
+ {
"cell_type": "markdown",
"metadata": {},
"source": [
@@ -679,6 +746,8 @@
]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"#### Troubleshooting\n",
"\n",
@@ -686,7 +755,7 @@
"\n",
"> To figure out how to open the web browser console, you may look at the
web browser documentation: \n",
"> Chrome: https://developer.chrome.com/docs/devtools/open/#console \n",
- "> Firefox:
https://developer.mozilla.org/en-US/docs/Tools/Web_Console#opening_the_web_console\n";,
+ "> Firefox:
https://developer.mozilla.org/en-US/docs/Tools/Web_Console#opening-the-web-console\n";,
"\n",
"The error is most probably linked to the JavaScript files not being
loaded or loaded in the wrong order within the HTML file. To analyze the error,
you can inspect the HTML file within the web browser (e.g.: right-click on the
page and select *View Page Source*) and look at the `<head>` section of the
page. That section should contain\n",
"some JavaScript libraries. Those relevant for widgets are:\n",
@@ -708,9 +777,7 @@
"\n",
"- If the widgets are **not displayed**, see
[#519](https://github.com/spatialaudio/nbsphinx/issues/519).\n",
"- If the widgets are **displayed multiple times**, see
[#378](https://github.com/spatialaudio/nbsphinx/issues/378)."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "markdown",
@@ -868,7 +935,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.7.5"
+ "version": "3.9.9"
}
},
"nbformat": 4,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/doc/conf.py
new/nbsphinx-0.8.9/doc/conf.py
--- old/nbsphinx-0.8.8/doc/conf.py 2021-12-31 12:18:04.000000000 +0100
+++ new/nbsphinx-0.8.9/doc/conf.py 2022-05-22 16:31:52.000000000 +0200
@@ -1,6 +1,6 @@
import os
-# Use sphinx-quickstart to create your own conf.py file!
+# You can use sphinx-quickstart to create your own conf.py file!
# After that, you have to edit a few things. See below.
# Select nbsphinx and, if needed, other Sphinx extensions:
@@ -26,12 +26,6 @@
# Don't add .txt suffix to source files:
html_sourcelink_suffix = ''
-# List of arguments to be passed to the kernel that executes the notebooks:
-nbsphinx_execute_arguments = [
- "--InlineBackend.figure_formats={'svg', 'pdf'}",
- "--InlineBackend.rc=figure.dpi=96",
-]
-
# Environment variables to be passed to the kernel:
os.environ['MY_DUMMY_VARIABLE'] = 'Hello from conf.py!'
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/doc/gallery/ipython_kernel_config.py
new/nbsphinx-0.8.9/doc/gallery/ipython_kernel_config.py
--- old/nbsphinx-0.8.8/doc/gallery/ipython_kernel_config.py 2021-04-07
13:12:40.000000000 +0200
+++ new/nbsphinx-0.8.9/doc/gallery/ipython_kernel_config.py 2022-04-10
15:35:02.000000000 +0200
@@ -1,2 +1,2 @@
-c.InlineBackend.figure_formats = {'svg'}
+c.InlineBackend.figure_formats = {'svg', 'pdf'}
c.InlineBackend.rc = {'figure.dpi': 96}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/doc/gallery/multiple-outputs.ipynb
new/nbsphinx-0.8.9/doc/gallery/multiple-outputs.ipynb
--- old/nbsphinx-0.8.8/doc/gallery/multiple-outputs.ipynb 2021-07-20
09:23:43.000000000 +0200
+++ new/nbsphinx-0.8.9/doc/gallery/multiple-outputs.ipynb 2022-04-10
15:35:02.000000000 +0200
@@ -48,7 +48,7 @@
"source": [
"from IPython.display import Image\n",
"\n",
- "display(Image(url='https://jupyter.org/assets/nav_logo.svg'))\n",
+
"display(Image(url='https://jupyter.org/assets/homepage/main-logo.svg'))\n",
"print('Hello!')\n",
"display(Image(filename='../images/notebook_icon.png'))\n",
"display(Image(url='https://www.python.org/static/img/python-logo-large.png',
embed=True))"
Binary files old/nbsphinx-0.8.8/doc/images/raw_cells.png and
new/nbsphinx-0.8.9/doc/images/raw_cells.png differ
Binary files old/nbsphinx-0.8.8/doc/images/raw_cells_jupyter_notebook.png and
new/nbsphinx-0.8.9/doc/images/raw_cells_jupyter_notebook.png differ
Binary files old/nbsphinx-0.8.8/doc/images/raw_cells_jupyterlab.png and
new/nbsphinx-0.8.9/doc/images/raw_cells_jupyterlab.png differ
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/doc/ipython_kernel_config.py
new/nbsphinx-0.8.9/doc/ipython_kernel_config.py
--- old/nbsphinx-0.8.8/doc/ipython_kernel_config.py 2021-04-07
13:12:40.000000000 +0200
+++ new/nbsphinx-0.8.9/doc/ipython_kernel_config.py 2022-04-10
15:35:02.000000000 +0200
@@ -1,2 +1,2 @@
-c.InlineBackend.figure_formats = {'svg'}
+c.InlineBackend.figure_formats = {'svg', 'pdf'}
c.InlineBackend.rc = {'figure.dpi': 96}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/doc/markdown-cells.ipynb
new/nbsphinx-0.8.9/doc/markdown-cells.ipynb
--- old/nbsphinx-0.8.8/doc/markdown-cells.ipynb 2021-12-07 13:02:04.000000000
+0100
+++ new/nbsphinx-0.8.9/doc/markdown-cells.ipynb 2022-04-10 15:35:12.000000000
+0200
@@ -364,9 +364,9 @@
" \n",
"Remote SVG images can also be used (and will be shown in the LaTeX
output):\n",
"\n",
- "\n",
+ "\n",
"\n",
- " "
+ " "
]
},
{
@@ -623,14 +623,20 @@
"[example_python_function()](a-normal-rst-file.rst#example_python_function)\n",
"```\n",
"\n",
- "This is especially useful for use with the Sphinx
[autodoc](https://www.sphinx-doc.org/en/master/ext/autodoc.html) extension!"
+ "This is especially useful for use with the Sphinx
[autodoc](https://www.sphinx-doc.org/en/master/ext/autodoc.html) extension!\n",
+ "\n",
+ "In some situations, you might prefer to have the default Sphinx
formatting and checking in place when linking to domain objects.\n",
+ "In such a case,\n",
+ "[raw cells in \"reST\" format](raw-cells.ipynb#reST)\n",
+ "could be an alternative worthwhile considering.\n",
+ "They allow one to use any kind of Sphinx roles and directives inside a
Jupyter Notebook."
]
}
],
"metadata": {
"celltoolbar": "Raw Cell Format",
"kernelspec": {
- "display_name": "Python 3",
+ "display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
@@ -644,7 +650,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.9.5"
+ "version": "3.8.8"
}
},
"nbformat": 4,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/doc/raw-cells.ipynb
new/nbsphinx-0.8.9/doc/raw-cells.ipynb
--- old/nbsphinx-0.8.8/doc/raw-cells.ipynb 2020-09-04 16:16:28.000000000
+0200
+++ new/nbsphinx-0.8.9/doc/raw-cells.ipynb 2022-04-10 15:35:02.000000000
+0200
@@ -15,17 +15,46 @@
"source": [
"# Raw Cells\n",
"\n",
- "The \"Raw NBConvert\" cell type can be used to render different code
formats into HTML or LaTeX by Sphinx. This information is stored in the
notebook metadata and converted appropriately.\n",
+ "Any Jupyter Notebook consists of cells of three different types:\n",
+ "[Code cells](./code-cells.ipynb),\n",
+ "[Markdown cells](./markdown-cells.ipynb)\n",
+ ", and/or Raw cells.\n",
+ "While most Jupyter Notebook users are very familiar with Code cells and
Markdown cells in Jupyter Notebooks, Raw cells are less frequently used.\n",
+ "For Jupyter Notebook, they are introduced\n",
+
"[here](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html?highlight=raw#raw-cells)\n",
+ "and for JupyterLab\n",
+
"[here](https://jupyterlab.readthedocs.io/en/stable/extension/notebook.html?highlight=raw#model).\n",
+ "The Raw cells are also sometimes referred to as Raw NBConvert cells in
the context of\n",
+
"[nbconvert](https://nbconvert.readthedocs.io/en/latest/architecture.html?highlight=raw#a-detailed-pipeline-exploration).\n",
+ "The Raw cell type can be used to render different code formats into HTML
or LaTeX by Sphinx.\n",
+ "This information is stored in the notebook metadata and converted
appropriately.\n",
"\n",
"## Usage\n",
"\n",
- "To select a desired format from within Jupyter, select the cell
containing your special code and choose options from the following dropdown
menus: \n",
+ "Raw cells are created differently depending on the user interface.\n",
"\n",
- "1. Select \"Raw NBConvert\"\n",
- "2. Switch the Cell Toolbar to \"Raw Cell Format\"\n",
- "3. Chose the appropriate \"Raw NBConvert Format\" within the cell\n",
+ "### Jupyter Notebook\n",
"\n",
- "\n",
+ "To select a desired format from within Jupyter Notebook, select the cell
containing your special code and choose options from the following dropdown
menus:\n",
+ "\n",
+ "1. Select \"Raw NBConvert\" in the Menu Toolbar (just below the two menus
\"Widgets\" and \"Help\").\n",
+ "2. Click on the \"Raw NBConvert Format\" dropdown menu within the cell
and select \"reST\".\n",
+ "\n",
+ "\n",
+ "<!-- this comment makes pandoc create an in-line image -->\n",
+ "\n",
+ "### JupyterLab\n",
+ "\n",
+ "To select a desired format from within JupyterLab, first activate the
right sidebar by clicking on View in the Menu Toolbar.\n",
+ "Then you ensure that in front of Show Right Sidebar there is a tick.\n",
+ "Once the Right Sidebar is shown, you are ready to go.\n",
+ "\n",
+ "Now you select the cell containing your special code and choose options
from the following dropdown menus:\n",
+ "\n",
+ "1. Select \"Raw\" in the Notebook Toolbar (just next to the symbols that
run cells or reload the kernel).\n",
+ "2. Click on \"Raw NBConvert Format\" in the Right Sidebar and select
\"reStructured Text\".\n",
+ "\n",
+ "\n",
"<!-- this comment makes pandoc create an in-line image -->"
]
},
@@ -61,7 +90,11 @@
"source": [
"### reST\n",
"\n",
- "Raw cells in \"reST\" format are interpreted as reStructuredText and
parsed by Sphinx. The result is visible in both HTML and LaTeX output. "
+ "Raw cells in \"reST\" format are interpreted as reStructuredText and
parsed by Sphinx.\n",
+ "Thus, you can e.g. use its\n",
+ "[cross-referencing
abilities](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects)\n",
+ "for automatically creating/updating links to the definition of modules,
classes, functions, and similar.\n",
+ "The result is visible in both HTML and LaTeX output."
]
},
{
@@ -72,6 +105,8 @@
"source": [
"\"**I'm** a *raw cell* in reST_ format.\"\n",
"\n",
+ "I can contain Sphinx roles such as a link to
:func:`example_python_function`.\n",
+ "\n",
".. _reST: https://www.sphinx-doc.org/rest.html";
]
},
@@ -152,7 +187,7 @@
"metadata": {
"celltoolbar": "Raw Cell Format",
"kernelspec": {
- "display_name": "Python 3",
+ "display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
@@ -166,9 +201,9 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.5.1+"
+ "version": "3.8.8"
}
},
"nbformat": 4,
- "nbformat_minor": 1
+ "nbformat_minor": 4
}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/doc/usage.ipynb
new/nbsphinx-0.8.9/doc/usage.ipynb
--- old/nbsphinx-0.8.8/doc/usage.ipynb 2021-12-07 13:02:04.000000000 +0100
+++ new/nbsphinx-0.8.9/doc/usage.ipynb 2022-04-10 15:35:02.000000000 +0200
@@ -252,6 +252,15 @@
"cell_type": "markdown",
"metadata": {},
"source": [
+ "#### `nbsphinx_assume_equations`\n",
+ "\n",
+ "If `False`, do not force loading MathJax on HTML pages generated from
notebooks."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
"#### `nbsphinx_codecell_lexer`\n",
"\n",
"Default Pygments lexer for syntax highlighting in code cells.\n",
@@ -297,19 +306,6 @@
"\n",
"Kernel arguments used when executing notebooks.\n",
"\n",
- "If you [use Matplotlib for plots](code-cells.ipynb#Plots),\n",
- "this setting is recommended:\n",
- "\n",
- "```python\n",
- "nbsphinx_execute_arguments = [\n",
- " \"--InlineBackend.figure_formats={'svg', 'pdf'}\",\n",
- " \"--InlineBackend.rc=figure.dpi=96\",\n",
- "]\n",
- "```\n",
- "\n",
- "If you don't use LaTeX/PDF output,\n",
- "you can drop the `'pdf'` figure format.\n",
- "\n",
"See [Configuring the
Kernels](configuring-kernels.ipynb#Kernel-Arguments)."
]
},
@@ -696,6 +692,51 @@
"cell_type": "markdown",
"metadata": {},
"source": [
+ "## Automatic Creation of HTML and PDF output on GitLab Pages\n",
+ "\n",
+ "When using GitLab pages, you can use nbsphinx by adding the file
`.gitlab-ci.yml` to your repo and copying the following lines into this
file:\n",
+ "```\n",
+ "image: python:3-slim\n",
+ "\n",
+ "variables:\n",
+ " PIP: python3 -m pip\n",
+ " SPHINX: python3 -m sphinx -W --keep-going --color\n",
+ "\n",
+ "build-docs:\n",
+ " stage: build\n",
+ " script:\n",
+ " - apt-get update -y\n",
+ " - apt-get install -y --no-install-recommends pandoc\n",
+ " - $PIP install -r doc/requirements.txt\n",
+ " - $SPHINX -d doctrees doc html -b html\n",
+ " - $SPHINX -d doctrees doc linkcheck -b linkcheck\n",
+ " artifacts:\n",
+ " when: always\n",
+ " paths:\n",
+ " - html\n",
+ " - linkcheck/output.*\n",
+ " \n",
+ "pages:\n",
+ " stage: deploy\n",
+ " variables:\n",
+ " GIT_STRATEGY: none\n",
+ " script:\n",
+ " - mv html public\n",
+ " artifacts:\n",
+ " paths:\n",
+ " - public\n",
+ " rules:\n",
+ " - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH\n",
+ "```\n",
+ "Note: \n",
+ "\n",
+ "You migh have to change the line `docs/` to `docs/source` in case that
you have this folder structure, which is the default when using
`sphinx-quickstart. "
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
"## HTML Themes\n",
"\n",
"The `nbsphinx` extension does *not* provide its own theme, you can use
any of the available themes or [create a custom
one](https://www.sphinx-doc.org/en/master/development/theming.html#creating-themes),
if you feel like it.\n",
@@ -786,10 +827,6 @@
" [example](https://nbsphinx.readthedocs.io/en/insipid-theme/),\n",
"
[usage](https://github.com/spatialaudio/nbsphinx/compare/insipid-theme^...insipid-theme)\n",
"\n",
- "* [jupyter](https://github.com/jupyter/jupyter-sphinx-theme/):\n",
- " [example](https://nbsphinx.readthedocs.io/en/jupyter-theme/),\n",
- "
[usage](https://github.com/spatialaudio/nbsphinx/compare/jupyter-theme^...jupyter-theme)\n",
- "\n",
"*
[maisie_sphinx_theme](https://github.com/maisie-dev/maisie-sphinx-theme):\n",
" [example](https://nbsphinx.readthedocs.io/en/maisie-theme/),\n",
"
[usage](https://github.com/spatialaudio/nbsphinx/compare/maisie-theme^...maisie-theme)\n",
@@ -802,6 +839,10 @@
" [example](https://nbsphinx.readthedocs.io/en/pydata-theme/),\n",
"
[usage](https://github.com/spatialaudio/nbsphinx/compare/pydata-theme^...pydata-theme)\n",
"\n",
+ "* [python_docs_theme](https://github.com/python/python-docs-theme):\n",
+ " [example](https://nbsphinx.readthedocs.io/en/python-docs-theme/),\n",
+ "
[usage](https://github.com/spatialaudio/nbsphinx/compare/python-docs-theme^...python-docs-theme)\n",
+ "\n",
"*
[pytorch_sphinx_theme](https://github.com/shiftlab/pytorch_sphinx_theme):\n",
" [example](https://nbsphinx.readthedocs.io/en/pytorch-theme/),\n",
"
[usage](https://github.com/spatialaudio/nbsphinx/compare/pytorch-theme^...pytorch-theme)\n",
@@ -890,7 +931,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
- "version": "3.9.2"
+ "version": "3.9.9"
}
},
"nbformat": 4,
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/setup.py new/nbsphinx-0.8.9/setup.py
--- old/nbsphinx-0.8.8/setup.py 2021-12-07 13:02:04.000000000 +0100
+++ new/nbsphinx-0.8.9/setup.py 2022-04-10 15:35:02.000000000 +0200
@@ -17,7 +17,7 @@
'docutils',
'jinja2',
'nbconvert!=5.4',
- 'traitlets',
+ 'traitlets>=5',
'nbformat',
'sphinx>=1.8',
],
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/src/nbsphinx.egg-info/PKG-INFO
new/nbsphinx-0.8.9/src/nbsphinx.egg-info/PKG-INFO
--- old/nbsphinx-0.8.8/src/nbsphinx.egg-info/PKG-INFO 2021-12-31
13:26:09.000000000 +0100
+++ new/nbsphinx-0.8.9/src/nbsphinx.egg-info/PKG-INFO 2022-06-04
20:28:43.000000000 +0200
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: nbsphinx
-Version: 0.8.8
+Version: 0.8.9
Summary: Jupyter Notebook Tools for Sphinx
Home-page: https://nbsphinx.readthedocs.io/
Author: Matthias Geier
@@ -55,5 +55,3 @@
.. _Sphinx: https://www.sphinx-doc.org/
.. _Jupyter Notebook: https://jupyter.org/
-
-
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/src/nbsphinx.egg-info/SOURCES.txt
new/nbsphinx-0.8.9/src/nbsphinx.egg-info/SOURCES.txt
--- old/nbsphinx-0.8.8/src/nbsphinx.egg-info/SOURCES.txt 2021-12-31
13:26:09.000000000 +0100
+++ new/nbsphinx-0.8.9/src/nbsphinx.egg-info/SOURCES.txt 2022-06-04
20:28:44.000000000 +0200
@@ -19,6 +19,7 @@
.circleci/artifact_path
.circleci/artifacts.html
.circleci/config.yml
+.github/workflows/html-macos.yml
.github/workflows/linkcheck.yml
doc/README
doc/a-markdown-file.md
@@ -61,7 +62,8 @@
doc/gallery/uno-rst.ipynb
doc/images/notebook_icon.png
doc/images/python_logo.svg
-doc/images/raw_cells.png
+doc/images/raw_cells_jupyter_notebook.png
+doc/images/raw_cells_jupyterlab.png
doc/subdir/a-notebook-in-a-subdir.ipynb
doc/subdir/gallery.ipynb
doc/subdir/toctree.ipynb
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/src/nbsphinx.egg-info/requires.txt
new/nbsphinx-0.8.9/src/nbsphinx.egg-info/requires.txt
--- old/nbsphinx-0.8.8/src/nbsphinx.egg-info/requires.txt 2021-12-31
13:26:09.000000000 +0100
+++ new/nbsphinx-0.8.9/src/nbsphinx.egg-info/requires.txt 2022-06-04
20:28:44.000000000 +0200
@@ -1,6 +1,6 @@
docutils
jinja2
nbconvert!=5.4
+traitlets>=5
nbformat
sphinx>=1.8
-traitlets
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-0.8.8/src/nbsphinx.py
new/nbsphinx-0.8.9/src/nbsphinx.py
--- old/nbsphinx-0.8.8/src/nbsphinx.py 2021-12-31 13:21:36.000000000 +0100
+++ new/nbsphinx-0.8.9/src/nbsphinx.py 2022-06-04 20:24:57.000000000 +0200
@@ -23,7 +23,7 @@
https://nbsphinx.readthedocs.io/
"""
-__version__ = '0.8.8'
+__version__ = '0.8.9'
import collections.abc
import copy
@@ -162,9 +162,12 @@
{{ output.data[datatype] | escape_latex | ansi2latex | indent | indent }}
\\end{sphinxVerbatim}
+{# NB: The "raw" directive doesn't work with empty content #}
+{%- if output.data[datatype].strip() %}
.. raw:: text
{{ output.data[datatype] | indent | indent }}
+{%- endif %}
{%- elif datatype in ['image/svg+xml', 'image/png', 'image/jpeg',
'application/pdf'] %}
@@ -360,7 +363,7 @@
\setbox\nbsphinxbox\vtop{{#1\par}}
% reserve some space at bottom of page, else start new page
\needspace{\dimexpr2.5\baselineskip+\ht\nbsphinxbox+\dp\nbsphinxbox}
- % mimick vertical spacing from \section command
+ % mimic vertical spacing from \section command
\addpenalty\@secpenalty
\@tempskipa 3.5ex \@plus 1ex \@minus .2ex\relax
\addvspace\@tempskipa
@@ -653,6 +656,7 @@
}
/* Some additional styling taken form the Jupyter notebook CSS */
+.jp-RenderedHTMLCommon table,
div.rendered_html table {
border: none;
border-collapse: collapse;
@@ -661,10 +665,14 @@
font-size: 12px;
table-layout: fixed;
}
+.jp-RenderedHTMLCommon thead,
div.rendered_html thead {
border-bottom: 1px solid black;
vertical-align: bottom;
}
+.jp-RenderedHTMLCommon tr,
+.jp-RenderedHTMLCommon th,
+.jp-RenderedHTMLCommon td,
div.rendered_html tr,
div.rendered_html th,
div.rendered_html td {
@@ -676,12 +684,15 @@
max-width: none;
border: none;
}
+.jp-RenderedHTMLCommon th,
div.rendered_html th {
font-weight: bold;
}
+.jp-RenderedHTMLCommon tbody tr:nth-child(odd),
div.rendered_html tbody tr:nth-child(odd) {
background: #f5f5f5;
}
+.jp-RenderedHTMLCommon tbody tr:hover,
div.rendered_html tbody tr:hover {
background: rgba(66, 165, 245, 0.2);
}
@@ -1237,7 +1248,7 @@
"""A thumbnail gallery for notebooks."""
def run(self):
- """Wrap GalleryToc arount toctree."""
+ """Wrap GalleryToc around toctree."""
ret = super().run()
try:
toctree_wrapper = ret[-1]
