Skip to content

play around with jupyterlite-sphinx #10299

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions ci/requirements/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ dependencies:
- iris
- jupyter_client
- jupyter_sphinx
- jupyterlite-sphinx
- jupyterlite-pyodide-kernel
- matplotlib-base
- nbsphinx
- ncdata
Expand Down
9 changes: 7 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
"sphinx_design",
"sphinx_inline_tabs",
"sphinx_remove_toctrees",
"jupyterlite_sphinx",
]


Expand Down Expand Up @@ -181,9 +182,13 @@
"pd.Index": "~pandas.Index",
"pd.NaT": "~pandas.NaT",
}

autodoc_type_aliases = napoleon_type_aliases # Keep both in sync

# jupyterlite try_examples config
global_enable_try_examples = True
try_examples_global_button_text = "Try it in your browser!"
try_examples_global_warning_text = "Interactive examples are experimental and may not always work as expected."

# mermaid config
mermaid_version = "10.9.1"

Expand Down Expand Up @@ -214,7 +219,7 @@

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


# The name of the Pygments (syntax highlighting) style to use.
Expand Down
3 changes: 3 additions & 0 deletions doc/try_examples.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"global_min_height": "400px"
}
Loading