Hello community,
here is the log from the commit of package python-jupyter_nbsphinx_link for
openSUSE:Factory checked in at 2018-08-03 12:39:33
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-jupyter_nbsphinx_link (Old)
and /work/SRC/openSUSE:Factory/.python-jupyter_nbsphinx_link.new (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-jupyter_nbsphinx_link"
Fri Aug 3 12:39:33 2018 rev:2 rq:627144 version:1.1.0
Changes:
--------
---
/work/SRC/openSUSE:Factory/python-jupyter_nbsphinx_link/python-jupyter_nbsphinx_link.changes
2018-06-03 12:37:21.281664859 +0200
+++
/work/SRC/openSUSE:Factory/.python-jupyter_nbsphinx_link.new/python-jupyter_nbsphinx_link.changes
2018-08-03 12:39:42.083783689 +0200
@@ -1,0 +2,6 @@
+Thu Aug 2 18:11:15 UTC 2018 - [email protected]
+
+- Update to 1.1.0
+ * Documentation and packaging fixes
+
+-------------------------------------------------------------------
Old:
----
nbsphinx-link-1.0.0.tar.gz
New:
----
nbsphinx-link-1.1.0.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-jupyter_nbsphinx_link.spec ++++++
--- /var/tmp/diff_new_pack.lwToVW/_old 2018-08-03 12:39:42.447784231 +0200
+++ /var/tmp/diff_new_pack.lwToVW/_new 2018-08-03 12:39:42.451784238 +0200
@@ -18,12 +18,12 @@
%{?!python_module:%define python_module() python-%{**} python3-%{**}}
Name: python-jupyter_nbsphinx_link
-Version: 1.0.0
+Version: 1.1.0
Release: 0
Summary: Sphinx extension for including notebook files outside sphinx
source root
License: BSD-3-Clause
Group: Development/Languages/Python
-Url: https://pypi.org/project/nbsphinx-link/
+Url: https://github.com/vidartf/nbsphinx-link
Source:
https://files.pythonhosted.org/packages/source/n/nbsphinx_link/nbsphinx-link-%{version}.tar.gz
BuildRequires: %{python_module devel}
BuildRequires: %{python_module jupyter_nbsphinx}
++++++ nbsphinx-link-1.0.0.tar.gz -> nbsphinx-link-1.1.0.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/MANIFEST.in
new/nbsphinx-link-1.1.0/MANIFEST.in
--- old/nbsphinx-link-1.0.0/MANIFEST.in 2017-11-29 13:09:35.000000000 +0100
+++ new/nbsphinx-link-1.1.0/MANIFEST.in 2018-05-25 15:42:58.000000000 +0200
@@ -1,2 +1,14 @@
include LICENSE
include *.rst
+include readthedocs.yml
+
+graft notebooks
+
+# Documentation
+graft docs
+exclude docs/\#*
+
+# docs subdirs we want to skip
+prune docs/build
+prune docs/gh-pages
+prune docs/dist
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/PKG-INFO
new/nbsphinx-link-1.1.0/PKG-INFO
--- old/nbsphinx-link-1.0.0/PKG-INFO 2017-11-29 13:45:55.000000000 +0100
+++ new/nbsphinx-link-1.1.0/PKG-INFO 2018-05-25 15:43:57.000000000 +0200
@@ -1,12 +1,11 @@
Metadata-Version: 1.1
Name: nbsphinx-link
-Version: 1.0.0
+Version: 1.1.0
Summary: A sphinx extension for including notebook files outside sphinx source
root
Home-page: UNKNOWN
Author: Vidar Tonaas Fauske
Author-email: [email protected]
License: BSD-3
-Description-Content-Type: UNKNOWN
Description: UNKNOWN
Keywords: Interactive,Interpreter,Shell,Web
Platform: Linux
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/README.rst
new/nbsphinx-link-1.1.0/README.rst
--- old/nbsphinx-link-1.0.0/README.rst 2017-11-29 13:39:03.000000000 +0100
+++ new/nbsphinx-link-1.1.0/README.rst 2018-05-23 17:36:54.000000000 +0200
@@ -25,3 +25,6 @@
}
Further keys might be added in the future.
+
+Note that the documentation of this project might serve as a
+further resource!
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/docs/Makefile
new/nbsphinx-link-1.1.0/docs/Makefile
--- old/nbsphinx-link-1.0.0/docs/Makefile 1970-01-01 01:00:00.000000000
+0100
+++ new/nbsphinx-link-1.1.0/docs/Makefile 2018-05-23 17:39:35.000000000
+0200
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SPHINXPROJ = nbsphinx-link
+SOURCEDIR = source
+BUILDDIR = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/docs/make.bat
new/nbsphinx-link-1.1.0/docs/make.bat
--- old/nbsphinx-link-1.0.0/docs/make.bat 1970-01-01 01:00:00.000000000
+0100
+++ new/nbsphinx-link-1.1.0/docs/make.bat 2018-05-23 17:39:35.000000000
+0200
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=nbsphinx-link
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively
you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/docs/source/conf.py
new/nbsphinx-link-1.1.0/docs/source/conf.py
--- old/nbsphinx-link-1.0.0/docs/source/conf.py 1970-01-01 01:00:00.000000000
+0100
+++ new/nbsphinx-link-1.1.0/docs/source/conf.py 2018-05-25 15:37:27.000000000
+0200
@@ -0,0 +1,214 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'nbsphinx-link'
+copyright = '2018, Vidar Tonaas Fauske'
+author = 'Vidar Tonaas Fauske'
+
+# The short X.Y version
+
+# get version from python package:
+import os
+here = os.path.dirname(__file__)
+repo = os.path.join(here, '..', '..')
+_version_py = os.path.join(repo, 'nbsphinx_link', '_version.py')
+version_ns = {}
+with open(_version_py) as f:
+ exec(f.read(), version_ns)
+
+# The short X.Y version.
+version = '%i.%i' % version_ns['version_info'][:2]
+# The full version, including alpha/beta/rc tags.
+release = version_ns['__version__']
+
+import subprocess
+try:
+ git_rev = subprocess.check_output(['git', 'describe', '--exact-match',
'HEAD'], universal_newlines=True)
+except subprocess.CalledProcessError:
+ try:
+ git_rev = subprocess.check_output(['git', 'rev-parse', 'HEAD'],
universal_newlines=True)
+ except subprocess.CalledProcessError:
+ git_rev = ''
+if git_rev:
+ git_rev = git_rev.splitlines()[0] + '/'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'nbsphinx',
+ 'nbsphinx_link',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+
+# Read The Docs
+# on_rtd is whether we are on readthedocs.org, this line of code grabbed from
+# docs.readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd: # only import and set the theme if we're building docs locally
+ import sphinx_rtd_theme
+ html_theme = 'sphinx_rtd_theme'
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# otherwise, readthedocs.org uses their theme by default, so no need to
specify it
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself. Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'nbsphinx-linkdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'nbsphinx-link.tex', 'nbsphinx-link Documentation',
+ 'Vidar Tonaas Fauske', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'nbsphinx-link', 'nbsphinx-link Documentation',
+ [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'nbsphinx-link', 'nbsphinx-link Documentation',
+ author, 'nbsphinx-link', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+
+# Ensure env.metadata[env.docname]['nbsphinx-link-target']
+# points relative to repo root:
+nbsphinx_link_target_root = repo
+
+
+nbsphinx_prolog = (
+r"""
+{% if env.metadata[env.docname]['nbsphinx-link-target'] %}
+{% set docpath = env.metadata[env.docname]['nbsphinx-link-target'] %}
+{% else %}
+{% set docpath = env.doc2path(env.docname, base='docs/source/') %}
+{% endif %}
+
+.. only:: html
+
+ .. role:: raw-html(raw)
+ :format: html
+
+ .. nbinfo::
+ This page was generated from `{{ docpath }}`__.
+
+ __ https://github.com/vidartf/nbsphinx-link/blob/
+ """ +
+git_rev + r"{{ docpath }}"
+)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/docs/source/index.rst
new/nbsphinx-link-1.1.0/docs/source/index.rst
--- old/nbsphinx-link-1.0.0/docs/source/index.rst 1970-01-01
01:00:00.000000000 +0100
+++ new/nbsphinx-link-1.1.0/docs/source/index.rst 2018-05-23
17:54:15.000000000 +0200
@@ -0,0 +1,33 @@
+
+nbsphinx-link
+=====================================
+
+Version: |release|
+
+**nbsphinx-link** is a `sphinx`_ extension built on `nbsphinx`_ that
+allows you to include Jupyter notebooks that sit outside your sphinx source
+directory in your documentation.
+
+
+In this documentation, the Installation section is written as a
+notebook included with nbsphinx, while the Introduction section
+is written as a notebook included with nbsphinx-link.
+
+
+Contents
+--------
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Installation and usage
+
+ installing
+ introduction
+
+
+
+.. links
+
+.. _`sphinx`: http://www.sphinx-doc.org
+
+.. _`nbsphinx`: https://nbsphinx.readthedocs.io
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/docs/source/installing.ipynb
new/nbsphinx-link-1.1.0/docs/source/installing.ipynb
--- old/nbsphinx-link-1.0.0/docs/source/installing.ipynb 1970-01-01
01:00:00.000000000 +0100
+++ new/nbsphinx-link-1.1.0/docs/source/installing.ipynb 2018-05-23
19:04:27.000000000 +0200
@@ -0,0 +1,56 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Installation"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "To install nbsphinx-link, run the following from a shell:\n",
+ "\n",
+ "```bash\n",
+ "pip install nbsphinx-link\n",
+ "```\n",
+ "\n",
+ "and add both `nbsphinx` and `nbsphinx_link` as extensions in your Sphinx
build config, typicalyl in `conf.py`:\n",
+ "\n",
+ "```python\n",
+ "\n",
+ "extensions = [\n",
+ " # ...\n",
+ " # any other extensions you need,\n",
+ " # ...\n",
+ " 'nbsphinx',\n",
+ " 'nbsphinx_link',\n",
+ "]\n",
+ "```"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Python 3",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.6.5"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/docs/source/introduction.nblink
new/nbsphinx-link-1.1.0/docs/source/introduction.nblink
--- old/nbsphinx-link-1.0.0/docs/source/introduction.nblink 1970-01-01
01:00:00.000000000 +0100
+++ new/nbsphinx-link-1.1.0/docs/source/introduction.nblink 2018-05-23
17:44:59.000000000 +0200
@@ -0,0 +1,3 @@
+{
+ "path": "../../notebooks/introduction.ipynb"
+}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/nbsphinx_link/__init__.py
new/nbsphinx-link-1.1.0/nbsphinx_link/__init__.py
--- old/nbsphinx-link-1.0.0/nbsphinx_link/__init__.py 2017-11-29
13:36:40.000000000 +0100
+++ new/nbsphinx-link-1.1.0/nbsphinx_link/__init__.py 2018-05-23
18:53:11.000000000 +0200
@@ -51,14 +51,18 @@
env = document.settings.env
source_dir = os.path.dirname(env.doc2path(env.docname))
- path = link['path']
- path = os.path.normpath(os.path.join(source_dir, path))
- path = utils.relative_path(None, path)
+ abs_path = os.path.normpath(os.path.join(source_dir, link['path']))
+ path = utils.relative_path(None, abs_path)
path = nodes.reprunicode(path)
document.settings.record_dependencies.add(path)
env.note_dependency(path)
+ target_root = env.config.nbsphinx_link_target_root
+ target = utils.relative_path(target_root, abs_path)
+ target = nodes.reprunicode(target).replace(os.path.sep, '/')
+ env.metadata[env.docname]['nbsphinx-link-target'] = target
+
try:
include_file = io.FileInput(source_path=path, encoding='utf8')
except UnicodeEncodeError as error:
@@ -83,5 +87,6 @@
"""Initialize Sphinx extension."""
app.setup_extension('nbsphinx')
app.add_source_parser('.nblink', LinkedNotebookParser)
+ app.add_config_value('nbsphinx_link_target_root', None, rebuild='env')
return {'version': __version__, 'parallel_read_safe': True}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/nbsphinx_link/_version.py
new/nbsphinx-link-1.1.0/nbsphinx_link/_version.py
--- old/nbsphinx-link-1.0.0/nbsphinx_link/_version.py 2017-11-29
13:45:25.000000000 +0100
+++ new/nbsphinx-link-1.1.0/nbsphinx_link/_version.py 2018-05-25
15:40:51.000000000 +0200
@@ -1,2 +1,2 @@
-version_info = (1, 0, 0)
+version_info = (1, 1, 0)
__version__ = ".".join(map(str, version_info))
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/nbsphinx_link.egg-info/PKG-INFO
new/nbsphinx-link-1.1.0/nbsphinx_link.egg-info/PKG-INFO
--- old/nbsphinx-link-1.0.0/nbsphinx_link.egg-info/PKG-INFO 2017-11-29
13:45:55.000000000 +0100
+++ new/nbsphinx-link-1.1.0/nbsphinx_link.egg-info/PKG-INFO 2018-05-25
15:43:56.000000000 +0200
@@ -1,12 +1,11 @@
Metadata-Version: 1.1
Name: nbsphinx-link
-Version: 1.0.0
+Version: 1.1.0
Summary: A sphinx extension for including notebook files outside sphinx source
root
Home-page: UNKNOWN
Author: Vidar Tonaas Fauske
Author-email: [email protected]
License: BSD-3
-Description-Content-Type: UNKNOWN
Description: UNKNOWN
Keywords: Interactive,Interpreter,Shell,Web
Platform: Linux
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore'
old/nbsphinx-link-1.0.0/nbsphinx_link.egg-info/SOURCES.txt
new/nbsphinx-link-1.1.0/nbsphinx_link.egg-info/SOURCES.txt
--- old/nbsphinx-link-1.0.0/nbsphinx_link.egg-info/SOURCES.txt 2017-11-29
13:45:55.000000000 +0100
+++ new/nbsphinx-link-1.1.0/nbsphinx_link.egg-info/SOURCES.txt 2018-05-25
15:43:56.000000000 +0200
@@ -1,12 +1,20 @@
LICENSE
MANIFEST.in
README.rst
+readthedocs.yml
setup.cfg
setup.py
+docs/Makefile
+docs/make.bat
+docs/source/conf.py
+docs/source/index.rst
+docs/source/installing.ipynb
+docs/source/introduction.nblink
nbsphinx_link/__init__.py
nbsphinx_link/_version.py
nbsphinx_link.egg-info/PKG-INFO
nbsphinx_link.egg-info/SOURCES.txt
nbsphinx_link.egg-info/dependency_links.txt
nbsphinx_link.egg-info/requires.txt
-nbsphinx_link.egg-info/top_level.txt
\ No newline at end of file
+nbsphinx_link.egg-info/top_level.txt
+notebooks/introduction.ipynb
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/notebooks/introduction.ipynb
new/nbsphinx-link-1.1.0/notebooks/introduction.ipynb
--- old/nbsphinx-link-1.0.0/notebooks/introduction.ipynb 1970-01-01
01:00:00.000000000 +0100
+++ new/nbsphinx-link-1.1.0/notebooks/introduction.ipynb 2018-05-23
19:13:55.000000000 +0200
@@ -0,0 +1,79 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Introduction"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "For a start, consider the documentation folder of the nbsphinx-link
repository. This documentation page itself comes from a linked notebook:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 1,
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "foobar\n"
+ ]
+ }
+ ],
+ "source": [
+ "def foo(a):\n",
+ " return 'foo' + a\n",
+ "\n",
+ "print(foo('bar'))"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "After the installation steps (installing the package, and adding
`nbsphinx_link` as an extension in the Sphinx config), you can link external
notebooks by including `.nblink` files in your documentation source tree. The
format of the link file is as follows:\n",
+ "\n",
+ "```json\n",
+ "{\n",
+ " \"path\": \"relative/path/to/notebook\"\n",
+ "}\n",
+ "```"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "It should then Just Work. For further information and examples, consider
inspecting the Sphinx config file of the nbsphinx-link repository!"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Python 3",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.6.5"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/nbsphinx-link-1.0.0/readthedocs.yml
new/nbsphinx-link-1.1.0/readthedocs.yml
--- old/nbsphinx-link-1.0.0/readthedocs.yml 1970-01-01 01:00:00.000000000
+0100
+++ new/nbsphinx-link-1.1.0/readthedocs.yml 2018-05-25 15:09:55.000000000
+0200
@@ -0,0 +1,4 @@
+type: sphinx
+python:
+ version: 3.5
+ pip_install: true
