nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-04-29 10:10:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/dev: Using mocking instead of importing external modules

Browse Source 
[sunil: Expand the full list of modules]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
This commit is contained in:
fliu 2021-08-17 18:51:49 -07:00 committed by Sunil Mohan Adapa
parent 3def7706db
commit 585433d427
No known key found for this signature in database
GPG Key ID: 43EA1CFF0AA7C5F2
1 changed files with 25 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/dev/conf.py
View File

@ -16,24 +16,8 @@ list see the documentation: http://www.sphinx-doc.org/en/master/config
import os import os
import sys import sys
import django
import django.conf
sys.path.insert(0, os.path.abspath('../../')) sys.path.insert(0, os.path.abspath('../../'))
# -- Django setup ------------------------------------------------------------
# Ensure that Django models can be imported by Sphinx
import plinth.settings # noqa pylint: disable=E402 isort:skip
kwargs = {}
for setting in dir(plinth.settings):
if setting.isupper():
kwargs[setting] = getattr(plinth.settings, setting)
django.conf.settings.configure(**kwargs)
django.setup(set_prefix=True)
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
# pylint: disable=invalid-name # pylint: disable=invalid-name
@ -209,4 +193,29 @@ autodoc_default_options = {
'special-members': '__init__', 'special-members': '__init__',
} }
# Mock importing packages
autodoc_mock_imports = [
'apt',
'augeas',
'axes',
'bootstrapform',
'captcha',
'cherrypy',
'configobj',
'dbus',
'django',
'gi',
'markupsafe',
'OpenSSL',
'pam',
'paramiko',
'psutil',
'pytest',
'requests',
'ruamel',
'setuptools',
'stronghold',
'yaml',
]
html_favicon = './_static/favicon.ico' html_favicon = './_static/favicon.ico'