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

update doc dependencies #180

Merged
merged 2 commits into from
Mar 1, 2025
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
4 changes: 2 additions & 2 deletions docs/getting-started/quickstart-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,7 @@ yhat = model.predict(X=x_valid, y=y_valid)

<div class="custom-collapsible-card">
<input type="checkbox" id="initial-info">
<label for="toggle-info">
<label for="initial-info">
📚 <strong>Looking for more details on what are initial conditions?</strong>
<span class="arrow">▼</span>
</label>
Expand Down Expand Up @@ -547,7 +547,7 @@ yhat_4_steps = model.predict(X=x_valid, y=y_valid, steps_ahead=4)

<div class="custom-collapsible-card">
<input type="checkbox" id="steps-info">
<label for="toggle-info">
<label for="steps-info">
📚 <strong>Looking for more details about how steps-ahead prediction works?</strong>
<span class="arrow">▼</span>
</label>
Expand Down
10 changes: 10 additions & 0 deletions docs/overrides/assets-2.0/js/katex.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
document$.subscribe(({ body }) => {

Check failure on line 1 in docs/overrides/assets-2.0/js/katex.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/overrides/assets-2.0/js/katex.js#L1

'document$' is not defined.
renderMathInElement(body, {

Check failure on line 2 in docs/overrides/assets-2.0/js/katex.js

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/overrides/assets-2.0/js/katex.js#L2

'renderMathInElement' is not defined.
delimiters: [
{ left: "$$", right: "$$", display: true },
{ left: "$", right: "$", display: false },
{ left: "\\(", right: "\\)", display: false },
{ left: "\\[", right: "\\]", display: true }
],
})
})
16 changes: 0 additions & 16 deletions docs/overrides/assets-2.0/js/mathjax.js

This file was deleted.

9 changes: 9 additions & 0 deletions docs/user-guide/API/basis-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,12 @@ template: overrides/main.html

::: sysidentpy.basis_function._polynomial
show_root_heading: false

::: sysidentpy.basis_function._hermite
show_root_heading: false

::: sysidentpy.basis_function._hermite_normalized
show_root_heading: false

::: sysidentpy.basis_function._laguerre
show_root_heading: false
19 changes: 10 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,17 @@ theme:

## Custom theme additions
extra_javascript:
- "overrides/assets-2.0/js/extra.js"
- "overrides/assets-2.0/js/mathjax.js"
- "https://polyfill.io/v3/polyfill.min.js?features=es6"
- "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
- https://polyfill.io/v3/polyfill.min.js?features=es6
- overrides/assets-2.0/js/katex.js
- https://unpkg.com/katex@0/dist/katex.min.js
- https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
- "overrides/assets-2.0/css/extra.css"
- "overrides/assets-2.0/css/feature-grid.css"
- "overrides/assets-2.0/css/fontsize.css"
- "overrides/assets-2.0/css/card-container.css"
- overrides/assets-2.0/css/extra.css
- overrides/assets-2.0/css/feature-grid.css
- overrides/assets-2.0/css/fontsize.css
- overrides/assets-2.0/css/card-container.css
- https://unpkg.com/katex@0/dist/katex.min.css

# Plugins
plugins:
Expand All @@ -89,7 +90,6 @@ plugins:
python:
options:
show_source: true
selection:
docstring_style: numpy

# Customization
Expand Down Expand Up @@ -144,6 +144,7 @@ markdown_extensions:
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- pymdownx.blocks.caption

# Page tree
nav:
Expand Down
19 changes: 9 additions & 10 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -72,22 +72,21 @@ examples = ["scikit-learn", "catboost"]

docs = [
"mkdocs >=1.1.2,<2.0.0",
"mkdocs-material >=8.1.4,<=9.5.21",
"mkdocs-material >=8.1.4,<=9.6.6",
"mdx-include >=1.4.1,<2.0.0",
"mkdocs-markdownextradata-plugin >=0.1.7,<=0.2.5",
"mkdocs-markdownextradata-plugin >=0.1.7,<=0.2.6",
# TODO: upgrade and enable typer-cli once it supports Click 8.x.x
# "typer-cli >=0.0.12,<0.0.13",
"typer >=0.4.1,<0.5.0",
"pyyaml >=5.3.1,<7.0.0",
"mkdocstrings[python]<=0.25.2",
"mkdocstrings-python<=1.10.8",
"mkdocs-redirects",
"mkdocs-minify-plugin<=0.6.4",
"mkdocs-glightbox <= 0.3.2",
"mkdocs-jupyter<=0.25.0",
"mkdocs-autorefs<=1.3.1",
"mkdocstrings[python]>=0.25.2, <0.29",
"mkdocs-redirects>=1.2.0",
"mkdocs-minify-plugin<=0.8.0",
"mkdocs-glightbox <= 0.4.0",
"mkdocs-jupyter<=0.25.1",
"mkdocs-autorefs>=1.3.1",
# avoid jinja import error using 3.0.3 version
"jinja2==3.0.3",
"jinja2>=3.0.3",
]
all = ["torch >=1.7.1, <2.4.0"]

Expand Down