Skip to content

Commit

Permalink
Workaround compatibility issue with sphinx-markdown-tables and markdo…
Browse files Browse the repository at this point in the history
…wn packages

See commentary in this commit, the upstream issue¹, our initial tracking
issue² (in another repo), and our Slack thread.³

¹ ryanfox/sphinx-markdown-tables#36
² nextstrain/ncov#982
³ https://bedfordlab.slack.com/archives/C01LCTT7JNN/p1658148441308079
  • Loading branch information
tsibley committed Jul 18, 2022
1 parent 6d1379f commit 88db52c
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,21 @@
},
install_requires = [
'sphinx_rtd_theme >=1.0.0',
'sphinx-copybutton'
'sphinx-copybutton',

# Many of our projects use sphinx-markdown-tables, which is
# incompatible with markdown 3.4.0 due to API changes.¹ Fix this with a
# single dep pin here instead of pins in all of those projects. The
# upshot is that previously-broken stable builds of projects (e.g. past
# releases) can be fixed retroactively since when re-built from the
# same source they'll find this new theme dep. The same wouldn't be
# true if we patched each repo individually.
#
# XXX TODO: Remove this once the compat issue¹ is resolved.
# -trs, 18 July 2022
#
# ¹ https://github.com/ryanfox/sphinx-markdown-tables/issues/36
'markdown <3.4.0',
],
classifiers = [
'Framework :: Sphinx',
Expand Down

0 comments on commit 88db52c

Please sign in to comment.