Skip to content

DOC: fix fake import for API docs #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 21, 2017
Merged

DOC: fix fake import for API docs #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
sys.path.insert(0, os.path.abspath('.'))

# Fake import to avoid actually loading CFFI and the PortAudio library
import fake_cffi
sys.modules['cffi'] = sys.modules['fake_cffi']
import fake__sounddevice
sys.modules['_sounddevice'] = sys.modules['fake__sounddevice']

# -- General configuration ------------------------------------------------

Expand Down
8 changes: 4 additions & 4 deletions doc/fake_cffi.py → doc/fake__sounddevice.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
"""Mock module for Sphinx autodoc."""


class FFI(object):
class ffi(object):

NULL = NotImplemented
I_AM_FAKE = True # This is used for the documentation of "default"

def cdef(self, _):
pass

def dlopen(self, _):
return FakeLibrary()


ffi = ffi()


class FakeLibrary(object):

# from portaudio.h:
Expand Down