From 02e07dda2a9b44b0fa7c62f11822c2bee5e4e148 Mon Sep 17 00:00:00 2001 From: Calum Lind Date: Fri, 29 Mar 2019 10:18:02 +0000 Subject: [PATCH] [Docs] Fix recommonmark monkey patch and pin version The refactored patch did not work so revert it. A new release of recommonmark breaks the docs build so pin it to working version. --- docs/source/conf.py | 19 +++++++++---------- requirements-docs.txt | 2 +- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 78377f5c0..ccc3b33e3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -26,18 +26,17 @@ try: except ImportError: get_version = None - -# Monkey patch -class PatchDummyStateMachine(DummyStateMachine): - """Fix recommonmark 0.4 doc reference issues.""" - - def run_role(self, name, *args, **kwargs): - if name == 'doc': - name = 'any' - return DummyStateMachine.run_role(self, name, *args, **kwargs) +# Monkey patch to fix recommonmark 0.4 doc reference issues. +orig_run_role = DummyStateMachine.run_role -DummyStateMachine = PatchDummyStateMachine +def run_role(self, name, options=None, content=None): + if name == 'doc': + name = 'any' + return orig_run_role(self, name, options, content) + + +DummyStateMachine.run_role = run_role # Must add these for autodoc to import packages successully __builtin__.__dict__['_'] = lambda x: x diff --git a/requirements-docs.txt b/requirements-docs.txt index e5437fc13..e23c1e1e3 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,3 +1,3 @@ sphinx==1.7.* -recommonmark +recommonmark==0.4.* sphinx_rtd_theme