Skip to content
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.

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

Sphinx docs update #42

Merged
merged 3 commits into from
May 14, 2024
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
6 changes: 3 additions & 3 deletions .github/workflows/pull-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
# Checkout, set up python
# ======
- name: Check out
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
Expand All @@ -24,7 +24,7 @@ jobs:
# ======
- name: Load cached Poetry installation
id: cached-poetry
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/.local # the path depends on the OS
key: poetry-${{ matrix.poetry-version }}
Expand All @@ -34,7 +34,7 @@ jobs:
# ======
- name: Load cached venv
id: cached-poetry-dependencies-docs
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: .venv
key: docs-${{ matrix.python-version }}-${{ matrix.poetry-version }}-${{ hashFiles('**/poetry.lock') }}
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/push-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
# Checkout, set up python
# ======
- name: Check out
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
Expand All @@ -27,7 +27,7 @@ jobs:
# ======
- name: Load cached Poetry installation
id: cached-poetry
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: ~/.local # the path depends on the OS
key: poetry-${{ matrix.poetry-version }}
Expand All @@ -44,7 +44,7 @@ jobs:
# ======
- name: Load cached venv
id: cached-poetry-dependencies-dev
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: .venv
key: dev-${{ matrix.python-version }}-${{ matrix.poetry-version }}-${{ hashFiles('**/poetry.lock') }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:

jobs:
release:
name: Deploy release to Test-PyPI
name: Deploy release to PyPI
runs-on: ubuntu-latest
environment:
# name: testpypi
Expand All @@ -21,7 +21,7 @@ jobs:
# Checkout, set up python
# ======
- name: Checkout source
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.7"
python: "3.9"
jobs:
post_create_environment:
- pip install poetry==1.2.1
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.

html_theme = 'sphinx_rtd_theme'
html_theme = 'classic'

# 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 = []
html_static_path = []
8 changes: 4 additions & 4 deletions docs/notebooks/Examples.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -333,13 +333,13 @@
},
"outputs": [],
"source": [
"tvd = derivative.TrendFiltered(alpha=1e-3, order=0, max_iter=1e6)\n",
"tvd = derivative.TrendFiltered(alpha=1e-3, order=0, max_iter=int(1e6))\n",
"plot_example(tvd, t, noisy_sin, np.cos, sigmas, 'order: 0')\n",
"\n",
"tvd = derivative.TrendFiltered(alpha=1e-3, order=1, max_iter=1e6)\n",
"tvd = derivative.TrendFiltered(alpha=1e-3, order=1, max_iter=int(1e6))\n",
"plot_example(tvd, t, noisy_sin, np.cos, sigmas, 'order: 1')\n",
"\n",
"tvd = derivative.TrendFiltered(alpha=1e-3, order=2, max_iter=1e6)\n",
"tvd = derivative.TrendFiltered(alpha=1e-3, order=2, max_iter=int(1e6))\n",
"plot_example(tvd, t, noisy_sin, np.cos, sigmas, 'order: 2')"
]
},
Expand Down Expand Up @@ -521,7 +521,7 @@
},
"outputs": [],
"source": [
"tvd = derivative.TrendFiltered(alpha=1e-3, order=0, max_iter=1e5)\n",
"tvd = derivative.TrendFiltered(alpha=1e-3, order=0, max_iter=int(1e5))\n",
"plot_example(tvd, t, noisy_abs, d_abs, sigmas, 'order: 0')"
]
},
Expand Down
Loading
Loading