Skip to content

Commit

Permalink
docs - add jquery extension to fix rtd theme
Browse files Browse the repository at this point in the history
The Read the Docs theme for sphinx relies on jQuery in a few spots. It
looks like we already have a sphinxcontrib-jquery but weren't
referencing it as an extension in conf.py.

Adding this seems more "workaround" than fix - it may be worth following
the related upstream issue or monkeypatching our way around jQuery in
c7n-sphinxext.

See also: readthedocs/sphinx_rtd_theme#1546
  • Loading branch information
ajkerrigan committed Aug 2, 2024
1 parent de58e2d commit 937f813
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@
'sphinx.ext.viewcode',
'c7n_sphinxext.docgen',
'myst_parser',
'sphinx_markdown_tables'
'sphinx_markdown_tables',
'sphinxcontrib.jquery',
]

# Extract only a classes docstrings
Expand Down

0 comments on commit 937f813

Please sign in to comment.