Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 15 additions & 5 deletions .github/workflows/testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,35 @@ on:
pull_request:
branches: [ master ]


env:
default-python: 3.10
default-python: "3.13"

jobs:
build:
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
tox_env: [py37, py38, py39, py310]
include:
- tox_env: py310
python-version: "3.10"
- tox_env: py311
python-version: "3.11"
- tox_env: py312
python-version: "3.12"
- tox_env: py313
python-version: "3.13"
- tox_env: style
python-version: "3.13"
- tox_env: check-manifest
python-version: "3.13"
- tox_env: coverage
python-version: "3.13"
- tox_env: docs
python-version: "3.13"
pandoc: true

# The operative sistem
runs-on: ${{ matrix.os || 'ubuntu-latest' }}
runs-on: ubuntu-latest

# the steps of the CI
steps:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,6 @@ result_images/
.pypirc
logtesting
outdata.prof

# MacOS files
*.DS_Store
24 changes: 12 additions & 12 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@ script:

jobs:
include:
- python: 3.6
env: TOXENV=py36
- python: 3.7
env: TOXENV=py37
- python: 3.8
env: TOXENV=py38
- python: 3.10
env: TOXENV=py310
env: TOXENV=py10
- python: 3.11
env: TOXENV=py11
- python: 3.12
env: TOXENV=py12
- python: 3.13
env: TOXENV=py313

- python: 3.10
- python: 3.12
env: TOXENV=style
- python: 3.10
- python: 3.12
env: TOXENV=coverage
- python: 3.10
- python: 3.12
env: TOXENV=docs
- python: 3.10
- python: 3.12
env: TOXENV=docstyle
- python: 3.10
- python: 3.12
env: TOXENV=check-manifest


Expand Down
2 changes: 2 additions & 0 deletions docs/requirements_docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ Sphinx>=5
nbsphinx>=0.8
sphinx-autobuild>=2021
sphinx-rtd-theme>=1
pygments>=2.0
jupyter
33 changes: 23 additions & 10 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@
"nbsphinx",
]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = [
"_build",
"source/.ipynb_checkpoints/*",
Expand All @@ -51,7 +54,11 @@

numpydoc_class_members_toctree = False

# nbsphinx_execute = 'never'
# nbsphinx configuration - don't execute notebooks by default
nbsphinx_execute = 'never'

# Allow nbsphinx to use fallback lexer for unknown languages
nbsphinx_codecell_lexer = 'ipython3'

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down Expand Up @@ -93,14 +100,12 @@
# Usually you set "language" from the command line for these cases.
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# Suppress warnings about unknown highlighting languages
suppress_warnings = ['misc.highlighting_failure']

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

Expand Down Expand Up @@ -224,12 +229,17 @@
import subs

if not ON_RTD: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
try:
import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme = "sphinx_rtd_theme"
except ImportError:
pass # Use default theme if sphinx_rtd_theme is not available
else:
from mock import Mock as MagicMock
try:
from unittest.mock import Mock as MagicMock
except ImportError:
from mock import Mock as MagicMock

class Mock(MagicMock):
@classmethod
Expand All @@ -243,3 +253,6 @@ def __getattr__(cls, name):
[".. _{}: {}".format(k, v) for k, v in subs.TARGETS.items()]
# ~ [".. |{}| replace:: {}".format(k, v) for k, v in subs.SUBSTITUTIONS.items()]
)

# nbsphinx handles IPython syntax highlighting automatically in modern versions
# No manual lexer registration needed
130 changes: 68 additions & 62 deletions docs/source/tutorial/Tutorial01.ipynb

Large diffs are not rendered by default.

33 changes: 20 additions & 13 deletions docs/source/tutorial/Tutorial02.ipynb

Large diffs are not rendered by default.

99 changes: 53 additions & 46 deletions docs/source/tutorial/Tutorial03.ipynb

Large diffs are not rendered by default.

90 changes: 45 additions & 45 deletions docs/source/tutorial/Tutorial04.ipynb

Large diffs are not rendered by default.

299 changes: 299 additions & 0 deletions docs/source/tutorial/Tutorial05.ipynb

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/source/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ Contents:
Tutorial02.ipynb
Tutorial03.ipynb
Tutorial04.ipynb
Tutorial05.ipynb
Loading