Skip to content

Commit

Permalink
Fix documentation build issues
Browse files Browse the repository at this point in the history
  • Loading branch information
minesh1291 committed Feb 16, 2025
1 parent bdf2a37 commit 56ca7d5
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 2 deletions.
10 changes: 9 additions & 1 deletion docs/docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,12 @@ sphinx-autodoc-typehints==1.25.2
sphinx-copybutton==0.5.2
myst-parser==2.0.0
nbsphinx==0.9.3
sphinx-design==0.5.0
sphinx-design==0.5.0
ipython
jupyter
matplotlib
numpy
pandas
scikit-learn
scipy
faiss-cpu
18 changes: 17 additions & 1 deletion docs/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,20 @@
'deflist',
]

nbsphinx_execute = 'never'
nbsphinx_execute = 'never'
nbsphinx_allow_errors = True
nbsphinx_kernel_name = 'python3'

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', '**.ipynb_checkpoints']

# The suffix(es) of source filenames.
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
'.ipynb': 'nbsphinx',
}
15 changes: 15 additions & 0 deletions docs/docs/source/examples/anomaly_detection.ipynb
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Anomaly Detection Example\n",
"\n",
"This notebook demonstrates how to use Time Series RAG for anomaly detection in sensor data.\n",
"\n",
"**Note**: This is a documentation example. To run this notebook, make sure you have installed the package and its dependencies:\n",
"\n",
"```bash\n",
"pip install -e .\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
15 changes: 15 additions & 0 deletions docs/docs/source/examples/pattern_recognition.ipynb
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Pattern Recognition Example\n",
"\n",
"This notebook demonstrates how to use Time Series RAG for pattern recognition tasks.\n",
"\n",
"**Note**: This is a documentation example. To run this notebook, make sure you have installed the package and its dependencies:\n",
"\n",
"```bash\n",
"pip install -e .\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down

0 comments on commit 56ca7d5

Please sign in to comment.