Skip to content

Commit b3d83c7

Browse files
Fix docs cad (mathLab#294)
* docs: resolve CAD rendering
1 parent a6450cf commit b3d83c7

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/source/conf.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,33 @@
2727

2828
# -- General configuration ------------------------------------------------
2929

30+
autodoc_mock_imports = [
31+
"OCC",
32+
"OCC.Core",
33+
"OCC.Core.TopoDS",
34+
"OCC.Core.TopExp",
35+
"OCC.Core.TopAbs",
36+
"OCC.Core.TopTools",
37+
"OCC.Core.GeomConvert",
38+
"OCC.Core.BRep",
39+
"OCC.Core.BRepBuilderAPI",
40+
"OCC.Core.BRepPrimAPI",
41+
"OCC.Core.BRepAlgoAPI",
42+
"OCC.Core.STEPControl",
43+
"OCC.Core.Interface",
44+
"OCC.Core.IFSelect",
45+
"OCC.Core.gp",
46+
"OCC.Core.TColgp",
47+
"OCC.Core.BRepOffsetAPI",
48+
"OCC.Core.BRepFilletAPI",
49+
"OCC.Core.Geom",
50+
"OCC.Extend",
51+
"OCC.Extend.TopologyUtils",
52+
"vtk",
53+
"vtk.util",
54+
"vtk.util.numpy_support"
55+
]
56+
3057
# Add any Sphinx extension module names here, as strings. They can be
3158
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3259
# ones.
@@ -321,3 +348,8 @@
321348
# If true, do not generate a @detailmenu in the "Top" node's menu.
322349
# texinfo_no_detailmenu = False
323350
autodoc_member_order = "bysource"
351+
352+
353+
# -- MathJax configuration -------------------------------------------------
354+
# This ensures that math formulae render correctly on hosted sites like GitHub Pages
355+
mathjax_path = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-AMS-MML_HTMLorMML'

0 commit comments

Comments
 (0)