summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/_templates/module.rst2
-rw-r--r--docs/source/all.rst32
-rw-r--r--docs/source/conf.py5
3 files changed, 24 insertions, 15 deletions
diff --git a/docs/source/_templates/module.rst b/docs/source/_templates/module.rst
index 5ad89be..495995e 100644
--- a/docs/source/_templates/module.rst
+++ b/docs/source/_templates/module.rst
@@ -2,6 +2,7 @@
{{ underline }}
.. automodule:: {{ fullname }}
+ :members:
{% block functions %}
{% if functions %}
@@ -12,6 +13,7 @@
{% for item in functions %}
.. autofunction:: {{ item }}
+
.. include:: backreferences/{{fullname}}.{{item}}.examples
diff --git a/docs/source/all.rst b/docs/source/all.rst
index 60cc85c..41d8e06 100644
--- a/docs/source/all.rst
+++ b/docs/source/all.rst
@@ -13,29 +13,33 @@ API and modules
:toctree: gen_modules/
:template: module.rst
- lp
+
backend
bregman
- smooth
- gromov
- optim
da
- dr
- utils
datasets
+ dr
+ factored
+ gaussian
+ gromov
+ lp
+ optim
+ partial
plot
- stochastic
- unbalanced
regpath
- partial
sliced
+ smooth
+ stochastic
+ unbalanced
+ utils
weak
- factored
- gaussian
+
-.. autosummary::
- :toctree: ../modules/generated/
- :template: module.rst
+Main :py:mod:`ot` functions
+--------------
.. automodule:: ot
:members:
+
+
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 3bec150..6e76291 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -119,7 +119,7 @@ release = __version__
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
@@ -341,6 +341,9 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
+autodoc_default_options = {'autosummary': True,
+ 'autosummary_imported_members': True}
+
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'python': ('https://docs.python.org/3', None),