Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: spatialaudio/nbsphinx
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 0.2.2
Choose a base ref
...
head repository: spatialaudio/nbsphinx
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref

Commits on Jan 6, 2016

  1. Copy the full SHA
    e486b95 View commit details

Commits on Jan 7, 2016

  1. Copy the full SHA
    99ff542 View commit details

Commits on Jan 15, 2016

  1. Change os.sep to '/'

    See #6.
    mgeier committed Jan 15, 2016
    Copy the full SHA
    266464b View commit details

Commits on Jan 16, 2016

  1. Use POSIX paths for image directive

    This hopefully fixes #9.
    mgeier committed Jan 16, 2016
    Copy the full SHA
    96f8787 View commit details

Commits on Jan 17, 2016

  1. Add CONTRIBUTING.rst

    mgeier committed Jan 17, 2016
    Copy the full SHA
    881997e View commit details
  2. Copy the full SHA
    af841a4 View commit details
  3. Make CSS more specific

    mgeier committed Jan 17, 2016
    Copy the full SHA
    488b41a View commit details

Commits on Jan 20, 2016

  1. Handle links to local files

    mgeier committed Jan 20, 2016
    Copy the full SHA
    9579f2b View commit details

Commits on Jan 22, 2016

  1. Copy the full SHA
    10a992f View commit details
  2. Release 0.2.3

    mgeier committed Jan 22, 2016
    Copy the full SHA
    2326455 View commit details
  3. Add <div=highlight> around tracebacks

    Some themes use this for their CSS.
    mgeier committed Jan 22, 2016
    Copy the full SHA
    bb5bf54 View commit details

Commits on Jan 23, 2016

  1. Copy the full SHA
    570f8d1 View commit details
  2. CSS: change |= selector to ^=

    This should have the same effect in our case and is probably easier to
    understand.
    mgeier committed Jan 23, 2016
    Copy the full SHA
    83b245e View commit details
  3. Copy the full SHA
    760d7b9 View commit details

Commits on Jan 26, 2016

  1. DOC: Refactor raw cell docs

    par2 authored and mgeier committed Jan 26, 2016
    Copy the full SHA
    14fbcc4 View commit details

Commits on Feb 2, 2016

  1. Copy the full SHA
    a2cc323 View commit details
  2. Copy the full SHA
    3cf14f4 View commit details

Commits on Feb 4, 2016

  1. Copy the full SHA
    4579724 View commit details

Commits on Feb 7, 2016

  1. Copy the full SHA
    b1d91bf View commit details

Commits on Feb 12, 2016

  1. Copy the full SHA
    3e60fa7 View commit details
  2. Copy the full SHA
    28b7691 View commit details
  3. Avoid warning on mailto: links

    mgeier committed Feb 12, 2016
    Copy the full SHA
    e0be724 View commit details
  4. Copy the full SHA
    23d0e46 View commit details
  5. Copy the full SHA
    20b0f8c View commit details
  6. Release 0.2.4

    mgeier committed Feb 12, 2016
    Copy the full SHA
    20f5502 View commit details

Commits on Feb 14, 2016

  1. DOC: Latex -> LaTeX

    mgeier committed Feb 14, 2016
    Copy the full SHA
    73bfd01 View commit details

Commits on Feb 24, 2016

  1. Copy the full SHA
    224a8ce View commit details

Commits on Feb 27, 2016

  1. Copy the full SHA
    0b80bbd View commit details

Commits on Feb 28, 2016

  1. Copy the full SHA
    83060c6 View commit details
  2. DOC: Mention latexmk

    mgeier committed Feb 28, 2016
    Copy the full SHA
    b5dacf5 View commit details

Commits on Feb 29, 2016

  1. DOC: Use the file extension in toctree

    I think this might be less confusing for Sphinx-newbies.
    mgeier committed Feb 29, 2016
    Copy the full SHA
    e2d1c1a View commit details
  2. Copy the full SHA
    77dc80e View commit details
  3. Add Exporter.__init__() docstring

    ... to disable the one from the base class.
    mgeier committed Feb 29, 2016
    Copy the full SHA
    617fa36 View commit details

Commits on Mar 1, 2016

  1. Copy the full SHA
    92a12e5 View commit details
  2. Copy the full SHA
    645258c View commit details

Commits on Mar 6, 2016

  1. Copy the full SHA
    10501bd View commit details
  2. Copy the full SHA
    f9c4890 View commit details
  3. Copy the full SHA
    282468f View commit details
  4. Copy the full SHA
    37c886f View commit details

Commits on Mar 15, 2016

  1. Copy the full SHA
    a069585 View commit details
  2. Release 0.2.5

    mgeier committed Mar 15, 2016
    Copy the full SHA
    6840e6c View commit details

Commits on Mar 19, 2016

  1. Copy the full SHA
    fec1da5 View commit details

Commits on Mar 23, 2016

  1. Copy the full SHA
    62b6121 View commit details

Commits on Mar 24, 2016

  1. Fix handling of empty lines

    The behavior must have been changed in one of the last few Sphinx
    releases ...
    mgeier committed Mar 24, 2016
    Copy the full SHA
    2b61f3f View commit details
  2. Execute notebooks only if they have code cells

    ... and no outputs (as before).
    mgeier committed Mar 24, 2016
    Copy the full SHA
    5b7d1c5 View commit details

Commits on Mar 26, 2016

  1. DOC: Use LaTeX package lmodern

    mgeier committed Mar 26, 2016
    Copy the full SHA
    50a5e51 View commit details
  2. DOC: Remove tocdepth from LaTeX preamble

    Sphinx now correctly "understands" the maxdepth option
    mgeier committed Mar 26, 2016
    Copy the full SHA
    e610eb4 View commit details

Commits on Mar 28, 2016

  1. Copy the full SHA
    2181601 View commit details

Commits on Apr 1, 2016

  1. Copy the full SHA
    00e637a View commit details
  2. Fix typo: emtpy -> empty

    tbekolay committed Apr 1, 2016
    Copy the full SHA
    6cd8c95 View commit details
Showing with 10,107 additions and 1,639 deletions.
  1. +10 −0 .binder/README
  2. 0 .binder/apt.txt
  3. +5 −0 .binder/postBuild
  4. +6 −0 .binder/requirements.txt
  5. +7 −0 .binder/start
  6. +1 −0 .circleci/artifact_path
  7. +28 −0 .circleci/artifacts.html
  8. +118 −0 .circleci/config.yml
  9. +7 −0 .editorconfig
  10. +6 −0 .github/dependabot.yml
  11. +46 −0 .github/workflows/html-macos.yml
  12. +53 −0 .github/workflows/linkcheck.yml
  13. +43 −0 .github/workflows/publish.yml
  14. +102 −0 .github/workflows/version-matrix.yml
  15. +9 −0 .gitignore
  16. +20 −0 .readthedocs.yml
  17. +122 −0 CONTRIBUTING.rst
  18. +1 −1 LICENSE
  19. +2 −6 MANIFEST.in
  20. +380 −4 NEWS.rst
  21. +13 −20 README.rst
  22. +5 −0 doc/README
  23. +58 −0 doc/a-markdown-file.md
  24. +337 −0 doc/a-normal-rst-file.rst
  25. +107 −0 doc/allow-errors-per-cell.ipynb
  26. +36 −41 doc/allow-errors.ipynb
  27. +909 −0 doc/code-cells.ipynb
  28. +181 −10 doc/conf.py
  29. +467 −0 doc/configuration.ipynb
  30. +126 −0 doc/configuring-kernels.ipynb
  31. +1 −0 doc/contributing.rst
  32. +151 −0 doc/custom-css.ipynb
  33. +75 −0 doc/custom-formats.pct.py
  34. +0 −541 doc/example.ipynb
  35. +60 −0 doc/executing-notebooks.ipynb
  36. +1 −0 doc/fallback_theme.txt
  37. +8 −0 doc/favicon.svg
  38. +120 −0 doc/gallery/cell-metadata.ipynb
  39. +98 −0 doc/gallery/cell-tag.ipynb
  40. +100 −0 doc/gallery/default-thumbnail.ipynb
  41. +21 −0 doc/gallery/due-rst.pct.py
  42. +90 −0 doc/gallery/gallery-with-links.ipynb
  43. +107 −0 doc/gallery/gallery-with-nested-documents.ipynb
  44. +1 −0 doc/gallery/matplotlibrc
  45. +79 −0 doc/gallery/multiple-outputs.ipynb
  46. +46 −0 doc/gallery/no-thumbnail.ipynb
  47. +135 −0 doc/gallery/thumbnail-from-conf-py.ipynb
  48. +46 −0 doc/gallery/uno-rst.ipynb
  49. +20 −7 doc/hidden-cells.ipynb
  50. BIN doc/images/raw_cells_jupyter_notebook.png
  51. BIN doc/images/raw_cells_jupyterlab.png
  52. +0 −56 doc/index.ipynb
  53. +72 −8 doc/index.rst
  54. +172 −0 doc/installation.ipynb
  55. +271 −17 doc/links.ipynb
  56. +680 −0 doc/markdown-cells.ipynb
  57. +1 −0 doc/matplotlibrc
  58. +75 −0 doc/never-execute.ipynb
  59. +25 −16 doc/orphan.ipynb
  60. +111 −28 doc/pre-executed.ipynb
  61. +144 −0 doc/prolog-and-epilog.ipynb
  62. +209 −0 doc/raw-cells.ipynb
  63. +21 −0 doc/references.bib
  64. +31 −0 doc/references.rst
  65. +14 −1 doc/requirements.txt
  66. +0 −75 doc/rst.rst
  67. +90 −0 doc/subdir/a-notebook-in-a-subdir.ipynb
  68. +0 −57 doc/subdir/another.ipynb
  69. +75 −0 doc/subdir/gallery.ipynb
  70. +144 −0 doc/subdir/toctree.ipynb
  71. +67 −0 doc/timeout.ipynb
  72. +414 −50 doc/usage.ipynb
  73. +4 −0 doc/version-history.rst
  74. +44 −0 doc/yet-another.ipynb
  75. +15 −0 git_rebase_theme_branches.sh
  76. +39 −0 include-in-latex/README.md
  77. +4 −0 include-in-latex/_templates/latex.tex_t
  78. +46 −0 include-in-latex/conf.py
  79. +18 −0 include-in-latex/latexmkrc
  80. +114 −0 include-in-latex/my-latex-document.tex
  81. +7 −0 include-in-latex/my-own-references.bib
  82. +24 −0 include-in-latex/pygmentize.py
  83. +1 −0 include-in-latex/sphinxlatexindbibtoc.sty
  84. +2 −0 include-in-latex/sphinxlatexstyleheadings.sty
  85. +1 −0 include-in-latex/sphinxoptionsgeometry.sty
  86. +0 −690 nbsphinx.py
  87. +3 −0 pyproject.toml
  88. +31 −11 setup.py
  89. +2,108 −0 src/nbsphinx/__init__.py
  90. +9 −0 src/nbsphinx/_static/nbsphinx-broken-thumbnail.svg
  91. +277 −0 src/nbsphinx/_static/nbsphinx-code-cells.css_t
  92. +31 −0 src/nbsphinx/_static/nbsphinx-gallery.css
  93. +9 −0 src/nbsphinx/_static/nbsphinx-no-thumbnail.svg
  94. +189 −0 src/nbsphinx/_texinputs/nbsphinx.sty
  95. +151 −0 theme_comparison.py
10 changes: 10 additions & 0 deletions .binder/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
This directory holds configuration files for https://mybinder.org/.

The notebooks that comprise the documentation can be accessed with this link:
https://mybinder.org/v2/gh/spatialaudio/nbsphinx/master?filepath=doc

To check out a different version, just replace "master" with the desired
branch/tag name or commit hash.

To use JupyterLab, use:
https://mybinder.org/v2/gh/spatialaudio/nbsphinx/master?urlpath=lab/tree/doc
Empty file added .binder/apt.txt
Empty file.
5 changes: 5 additions & 0 deletions .binder/postBuild
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/sh

set -e

# add your shell commands here
6 changes: 6 additions & 0 deletions .binder/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
matplotlib
ipympl
pandas
ipywidgets
jupytext
jupyterlab>=3
7 changes: 7 additions & 0 deletions .binder/start
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash

# https://mybinder.readthedocs.io/en/latest/config_files.html#start-run-code-before-the-user-sessions-starts

export MY_DUMMY_VARIABLE="Hello from .binder/start!"

exec "$@"
1 change: 1 addition & 0 deletions .circleci/artifact_path
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0/artifacts.html
28 changes: 28 additions & 0 deletions .circleci/artifacts.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!DOCTYPE html>
<title>CircleCI artifacts for nbsphinx</title>
<style>
body {
margin: 0;
}
div {
position: absolute;
width: 100%;
top: 4em;
bottom: 2px;
}
iframe {
border: none;
border-top: solid 2px;
width: 50%;
height: 100%;
float: left;
}
</style>
<ul>
<li><a href="html/index.html">HTML</a></li>
<li><a href="nbsphinx.pdf">PDF</a></li>
</ul>
<div>
<iframe src="html/index.html"></iframe>
<iframe src="nbsphinx.pdf"></iframe>
</div>
118 changes: 118 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Python CircleCI 2.0 configuration file
#
# Check https://circleci.com/docs/2.0/language-python/ for more details
#
version: 2
jobs:
build_docs:
docker:
- image: texlive/texlive

working_directory: ~/checkout

environment:
PIP_INSTALL: python -m pip install --progress-bar off --upgrade
SPHINX: python -m sphinx -W --keep-going --color

steps:
- checkout

- store_artifacts:
name: Uploading overview page
path: .circleci/artifacts.html
destination: artifacts.html

- run:
name: Installing apt Packages
command: |
apt-get -y update
apt-get install -y --no-install-recommends python3-venv librsvg2-bin binutils pandoc
- restore_cache:
keys:
- v1-deps-{{ .Branch }}-{{ checksum "doc/requirements.txt" }}
# fallbacks
- v1-deps-{{ .Branch }}-
- v1-deps-

- run:
name: Set up venv
command: |
python3 -m venv .venv
echo "source .venv/bin/activate" >> $BASH_ENV
- run:
name: Installing Sphinx
# See https://github.com/sphinx-doc/sphinx/issues/12331
command: |
$PIP_INSTALL "sphinx !=7.3.0, != 7.3.1, != 7.3.2, != 7.3.3, != 7.3.4, != 7.3.5, != 7.3.6, != 7.3.7"
- run:
name: Installing nbsphinx
command: |
$PIP_INSTALL .
- run:
name: Installing doc Dependencies
command: |
$PIP_INSTALL -r doc/requirements.txt
- save_cache:
paths:
- ~/.cache/pip
key: v1-deps-{{ .Branch }}-{{ checksum "doc/requirements.txt" }}

- run:
name: Show pandoc version
command: |
pandoc --version
- run:
name: Building HTML
command: |
$SPHINX -d build/doctrees doc build/html -b html
- store_artifacts:
name: Uploading HTML files
path: build/html
destination: html

- run:
name: Building LaTeX
command: |
$SPHINX -d build/doctrees doc build/latex -b latex
- run:
name: Building PDF
command: |
cd build/latex
latexmk -pdflua
- store_artifacts:
name: Uploading PDF file
path: build/latex/nbsphinx.pdf
destination: nbsphinx.pdf

- run:
name: Building LaTeX document with nbsphinx docs as chapter
# NB: There is a warning about :footcite:, so we are not using "-W"
command: |
cd include-in-latex
python -m sphinx --color ../doc _build -c . -b latex
- run:
name: Building PDF of above
command: |
cd include-in-latex
latexmk
- store_artifacts:
name: Uploading another PDF file
path: include-in-latex/my-latex-document.pdf
destination: my-latex-document.pdf

workflows:
version: 2
build-me-my-docs:
jobs:
- build_docs
7 changes: 7 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -13,3 +13,10 @@ trim_trailing_whitespace = true

[*.py]
max_line_length = 79

[*.ipynb]
max_line_length = off

[*.yml]
indent_size = 2
max_line_length = off
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
46 changes: 46 additions & 0 deletions .github/workflows/html-macos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Build HTML on macOS
on: [push, pull_request]
env:
PYTHONWARNINGS: error
PIP: python -m pip
SPHINX: python -m sphinx -W --keep-going --color
jobs:
html-macos:
runs-on: macos-latest
steps:
- name: Clone repo
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install pandoc
run: |
brew install pandoc
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3
- name: Double-check Python version
run: |
python --version
- name: Install Python package
env:
# DeprecationWarning: Unimplemented abstract methods {'locate_file'}
# https://github.com/pypa/pip/issues/11684
PYTHONWARNINGS: error,default::DeprecationWarning
run: |
$PIP install .
- name: Install docs dependencies
env:
# DeprecationWarning: Unimplemented abstract methods {'locate_file'}
# https://github.com/pypa/pip/issues/11684
PYTHONWARNINGS: error,default::DeprecationWarning
run: |
$PIP install -r doc/requirements.txt
- name: Build HTML
env:
# There is a weird warning from jupyter_core (https://github.com/jupyter/jupyter_core/issues/398)
# RemovedInSphinx10Warning: 'sphinx.util.import_object' is deprecated
# https://github.com/sphinx-doc/sphinx/issues/13083
PYTHONWARNINGS: error,default::DeprecationWarning,default:'sphinx.util.import_object'
run: |
$SPHINX doc/ _build/html/
53 changes: 53 additions & 0 deletions .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Check links in documentation
on: [push, pull_request]
env:
PYTHONWARNINGS: error
APT_INSTALL: sudo apt-get install -y --no-install-recommends
PIP: python -m pip
SPHINX: python -m sphinx -W --keep-going --color
jobs:
linkcheck:
runs-on: ubuntu-latest
steps:
- name: Clone repo
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install pandoc
run: |
$APT_INSTALL pandoc
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3"
- name: Show Python version
run: |
python --version
- name: Install Python package
env:
# DeprecationWarning: Unimplemented abstract methods {'locate_file'}
# https://github.com/pypa/pip/issues/11684
PYTHONWARNINGS: error,default::DeprecationWarning
run: |
$PIP install .
- name: Install docs dependencies
env:
# DeprecationWarning: Unimplemented abstract methods {'locate_file'}
# https://github.com/pypa/pip/issues/11684
PYTHONWARNINGS: error,default::DeprecationWarning
run: |
$PIP install -r doc/requirements.txt
- name: Check links
env:
# There is a weird warning from jupyter_core (https://github.com/jupyter/jupyter_core/issues/398)
# RemovedInSphinx10Warning: 'sphinx.util.import_object' is deprecated
# https://github.com/sphinx-doc/sphinx/issues/13083
PYTHONWARNINGS: error,default::DeprecationWarning,default:'sphinx.util.import_object'
run: |
$SPHINX -d _doctrees/ doc/ _build/linkcheck/ -b linkcheck -q
- name: Upload results
uses: actions/upload-artifact@v4
if: ${{ success() || failure() }}
with:
name: linkcheck
path: _build/linkcheck/output.*
43 changes: 43 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Build and publish to PyPI
on: push
jobs:
build:
name: Build distribution
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3"
- name: Install "build"
run: |
python -m pip install build
- name: Build a binary wheel and a source tarball
run: python -m build
- name: Store the distribution packages
uses: actions/upload-artifact@v4
with:
name: dist
path: dist
publish:
name: Upload release to PyPI
if: startsWith(github.ref, 'refs/tags/')
needs:
- build
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/nbsphinx
permissions:
id-token: write
steps:
- name: Get the artifacts
uses: actions/download-artifact@v4
with:
name: dist
path: dist
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
print-hash: true
Loading