mirror of
https://github.com/adrienverge/yamllint.git
synced 2025-02-25 18:55:20 -06:00
docs(readthedocs): Fix builds on yamllint.readthedocs.io
Documentation builds on readthedocs.io partly fail because some modules imported by yammlint cannot be imported in Sphinx automodule. This commit fixes that using the tip at [1]. Closes #66 [1]: http://docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
This commit is contained in:
13
docs/conf.py
13
docs/conf.py
@@ -4,6 +4,7 @@
|
||||
|
||||
import sys
|
||||
import os
|
||||
from unittest.mock import MagicMock
|
||||
|
||||
sys.path.insert(0, os.path.abspath('..')) # noqa
|
||||
|
||||
@@ -40,3 +41,15 @@ htmlhelp_basename = 'yamllintdoc'
|
||||
man_pages = [
|
||||
('index', 'yamllint', '', [u'Adrien Vergé'], 1)
|
||||
]
|
||||
|
||||
# -- Build with sphinx automodule without needing to install third-party libs
|
||||
|
||||
|
||||
class Mock(MagicMock):
|
||||
@classmethod
|
||||
def __getattr__(cls, name):
|
||||
return MagicMock()
|
||||
|
||||
|
||||
MOCK_MODULES = ['pathspec', 'yaml']
|
||||
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
|
||||
|
||||
Reference in New Issue
Block a user