Skip to content

Commit 5f9520d

Browse files
committed
fix i18n & (I hope) mathjax
1 parent 333642a commit 5f9520d

File tree

3 files changed

+16
-27
lines changed

3 files changed

+16
-27
lines changed

.github/workflows/test_builddocsite.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ jobs:
2929
- name: Sphinx setup
3030
run: |
3131
pip install sphinx sphinx_readable_theme
32-
- name: mkdocs setup
33-
run: |
34-
pip install mkdocs mkdocs-material python-markdown-math mkdocs-i18n
3532
- name: pandoc setup
3633
uses: pandoc/actions/setup@v1
34+
- name: mkdocs setup
35+
run: |
36+
pip install mkdocs mkdocs-material python-markdown-math mkdocs-static-i18n
3737
3838
- name: Checkout
3939
uses: actions/checkout@v4

MDhelp/README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,4 @@ These files have had only minor editing. A few need to be broken up:
2828
39 docs/singlecrystal.md
2929
94 docs/smallanglescattering.md
3030

31-
Removed internationalization (i18n from mkdocs.yml) because of error
32-
message from mkdocs:
33-
34-
(/tmp/py313) py3.13 MDhelp % mkdocs build
35-
ERROR - Config value 'plugins': Plugin 'i18n' option 'languages': Expected
36-
type: <class 'dict'> but received: <class 'list'>
37-
38-
when using:
39-
40-
pip install mkdocs mkdocs-material python-markdown-math mkdocs-i18n
41-
42-
Successfully installed babel-2.17.0 backrefs-5.9 certifi-2025.7.14 charset_normalizer-3.4.2 click-8.2.1 colorama-0.4.6 ghp-import-2.1.0 idna-3.10 jinja2-3.1.6 markdown-3.8.2 markupsafe-3.0.2 mergedeep-1.3.4 mkdocs-1.6.1 mkdocs-get-deps-0.2.0 mkdocs-i18n-0.4.6 mkdocs-material-9.6.15 mkdocs-material-extensions-1.3.1 packaging-25.0 paginate-0.5.7 pathspec-0.12.1 platformdirs-4.3.8 pygments-2.19.2 pymdown-extensions-10.16 python-dateutil-2.9.0.post0 python-markdown-math-0.9 pyyaml-6.0.2 pyyaml-env-tag-1.1 requests-2.32.4 six-1.17.0 urllib3-2.5.0 watchdog-6.0.0
31+
N.B. must use `mkdocs-static-i18n` not `mkdocs-i18n` as in `pip install mkdocs mkdocs-material python-markdown-math mkdocs-static-i18n`

MDhelp/mkdocs.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,25 @@ theme:
2626
favicon: images/gsas2.png
2727
logo: images/gsas2.png
2828

29-
# plugins:
30-
# - i18n:
31-
# docs_structure: suffix
32-
# languages:
33-
# - locale: en
34-
# default: true
35-
# name: English
36-
# build: true
37-
# - locale: ja
38-
# name: 日本語
39-
# build: true
29+
plugins:
30+
- i18n:
31+
docs_structure: suffix
32+
languages:
33+
- locale: en
34+
default: true
35+
name: English
36+
build: true
37+
# - locale: ja
38+
# name: 日本語
39+
# build: true
4040

4141
markdown_extensions:
4242
- def_list
4343
- admonition
4444
- mdx_math
4545

4646
extra_javascript:
47-
- http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
47+
- https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
4848

4949
#local build settings from https://www.mkdocs.org/user-guide/deploying-your-docs/#local-files
5050

0 commit comments

Comments
 (0)