swh:1:snp:02443124ed4ee0d8d724fefd38bf9b271361cc09
Tip revision: 25bfa1d9d55358292cbdf185f96f20c4d9f17893 authored by Jan-Michael Rye on 03 October 2023, 13:20:55 UTC
Add MolPred link to README
Add MolPred link to README
Tip revision: 25bfa1d
conf.py
#!/usr/bin/env python3
'''
Sphinx configuration file.
'''
# pylint: disable=invalid-name,redefined-builtin
import importlib
import pathlib
import sys
source_code = '../../src'
git_url = 'https://gitlab.inria.fr/jrye/chemfeat'
this_path = pathlib.Path(__file__).resolve()
sys.path.insert(0, str((this_path.parent / source_code).resolve()))
author = 'Jan-Michael Rye'
copyright = '2023, Inria'
project = 'ChemFeat'
html_theme = 'sphinx_rtd_theme'
autodoc_mock_imports = [
'PaDEL_pywrapper',
'docstring_parser',
'pandas',
'rdkit',
'simple_file_lock',
'yaml'
]
extensions = [
'myst_parser',
'sphinx.ext.autodoc',
'sphinx.ext.linkcode',
'sphinx.ext.napoleon',
'sphinx.ext.todo'
]
index_entries = [
'gen_command_help',
'gen_feature_set_configuration',
'gen_features'
]
def skip(_app, _what, name, _obj, would_skip, _options): # pylint: disable=too-many-arguments
'''Customize autodoc member skipping.'''
if name == '__init__':
return False
return would_skip
def setup(app):
'''Connect the skip function.'''
app.connect('autodoc-skip-member', skip)
def linkcode_resolve(domain, info):
'''Get source links for the linkcode extension.'''
module = info['module']
if domain != 'py' or not module:
return None
top_mod = importlib.import_module(module.split('.')[0])
mod = importlib.import_module(module)
top_mod_path = pathlib.Path(top_mod.__file__)
mod_path = pathlib.Path(mod.__file__)
subpath = str(mod_path.relative_to(top_mod_path.parent.parent))
return f'{git_url}/-/blob/main/src/{subpath}'