summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRémi Flamary <remi.flamary@gmail.com>2021-04-22 10:54:26 +0200
committerGitHub <noreply@github.com>2021-04-22 10:54:26 +0200
commitd06eee87155cdc6702c0dc8fe933dc02d9efdada (patch)
tree99c35c70fcd193cd463d01c0c33aabd189035f16 /docs
parent0d995011b19b243bc980588cd98786b7c41a0509 (diff)
[WIP] Build doc in master and stable separately and have both versions on the website (#243)
* add bild doc action workflow * new build * build full doc * remove github action and update circleci builder * add versions in doc and change dev number
Diffstat (limited to 'docs')
-rw-r--r--docs/source/_templates/versions.html43
-rw-r--r--docs/source/conf.py4
2 files changed, 45 insertions, 2 deletions
diff --git a/docs/source/_templates/versions.html b/docs/source/_templates/versions.html
new file mode 100644
index 0000000..10d60d7
--- /dev/null
+++ b/docs/source/_templates/versions.html
@@ -0,0 +1,43 @@
+<div class="rst-versions shift-up" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book"> Python Optimal Transport</span>
+ versions
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions"><!-- Inserted RTD Footer -->
+
+<div class="injected">
+
+
+
+ <dl>
+ <dt>Versions</dt>
+
+ <dd><a href="https://pythonot.github.io/master">latest</a></dd>
+
+ <dd><a href="https://pythonot.github.io/">stable</a></dd>
+
+ </dl>
+
+
+
+
+ <dl>
+ <dt>On GitHub</dt>
+ <dd>
+ <a href="https://github.com/PythonOT/POT">Code on Github</a>
+ </dd>
+
+ </dl>
+
+
+
+
+
+ <hr>
+
+
+
+</div>
+</div>
+ </div> \ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 384bf40..3a11798 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -92,7 +92,7 @@ master_doc = 'index'
# General information about the project.
project = u'POT Python Optimal Transport'
-copyright = u'2016-2020, Rémi Flamary, Nicolas Courty'
+copyright = u'2016-2021, Rémi Flamary, Nicolas Courty'
author = u'Rémi Flamary, Nicolas Courty'
# The version info for the project you're documenting, acts as replacement for
@@ -162,7 +162,7 @@ html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []