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

chore: added install for mkdocs insiders #1481

Merged
merged 2 commits into from
Oct 13, 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
13 changes: 2 additions & 11 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,6 @@ build:
python: "3.12"
commands:
- pip install -e .[docs]
- if [ -n "$GH_TOKEN" ]; then pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git; fi
- python scripts/gen_ref_pages.py
- mkdocs build --site-dir $READTHEDOCS_OUTPUT/html

# mkdocs:
# configuration: mkdocs.yml

# python:
# install:
# - method: pip
# path: .
# extra_requirements:
# - docs
- mkdocs build --site-dir $READTHEDOCS_OUTPUT/html
14 changes: 7 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,10 @@ nav:
- ❤️ Community: community/index.md

# https://www.mkdocs.org/user-guide/configuration/#validation
# validation:
# omitted_files: warn
# absolute_links: warn
# unrecognized_links: warn
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn

# Material-Docs Theme
theme:
Expand Down Expand Up @@ -216,16 +216,16 @@ plugins:
signature_crossrefs: true
- mkdocs-jupyter:
execute: false
# include: ["*.ipynb"]
ignore: ["*.md", "*.ipynb"]
include: ["*.ipynb"]
ignore: ["*.md"]
jupyter_options:
hide_input: false
hide_output: false
code_folding: true
code_line_numbers: true
jupyter_images: true
jupyter_table_beautifier: true
# - glightbox
- glightbox

extra_javascript:
- _static/js/mathjax.js
Expand Down
Loading