diff options
| author | Rémi Flamary <remi.flamary@gmail.com> | 2020-04-21 17:48:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-21 17:48:37 +0200 |
| commit | a303cc6b483d3cd958c399621e22e40574bcbbc8 (patch) | |
| tree | dea049cb692020462da8f00d9e117f93b839bb55 /docs/source/conf.py | |
| parent | 0b2d808aaebb1cab60a272ea7901d5f77df43a9f (diff) | |
[MRG] Actually run sphinx-gallery (#146)
* generate gallery
* remove mock
* add sklearn to requirermnt?txt for example
* remove latex from fgw example
* add networks for graph example
* remove all
* add requirement.txt rtd
* rtd debug
* update readme
* eradthedoc with redirection
* add conf rtd
Diffstat (limited to 'docs/source/conf.py')
| -rw-r--r-- | docs/source/conf.py | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index d29b829..880c71d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,9 +34,11 @@ class Mock(MagicMock): @classmethod def __getattr__(cls, name): return MagicMock() -MOCK_MODULES = ['ot.lp.emd_wrap','autograd','pymanopt','cupy','autograd.numpy','pymanopt.manifolds','pymanopt.solvers'] + + +MOCK_MODULES = ['ot.lp.emd_wrap', 'autograd', 'pymanopt', 'cupy', 'autograd.numpy', 'pymanopt.manifolds', 'pymanopt.solvers'] # 'autograd.numpy','pymanopt.manifolds','pymanopt.solvers', -sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) +#sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) # !!!! # If extensions (or modules to document with autodoc) are in another directory, @@ -65,7 +67,7 @@ extensions = [ 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', - #'sphinx_gallery.gen_gallery', + 'sphinx_gallery.gen_gallery', ] napoleon_numpy_docstring = True @@ -248,17 +250,17 @@ htmlhelp_basename = 'POTdoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + #'preamble': '', -# Latex figure (float) alignment -#'figure_align': 'htbp', + # Latex figure (float) alignment + #'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples @@ -334,7 +336,7 @@ intersphinx_mapping = {'python': ('https://docs.python.org/3', None), 'matplotlib': ('http://matplotlib.sourceforge.net/', None)} sphinx_gallery_conf = { - 'examples_dirs': ['../../examples','../../examples/da'], + 'examples_dirs': ['../../examples', '../../examples/da'], 'gallery_dirs': 'auto_examples', 'backreferences_dir': '../modules/generated/', 'reference_url': { |