Skip to content

Commit 2fdc77e

Browse files
committed
Add note reagarding adjustments to the project
1 parent 7ade8a3 commit 2fdc77e

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

exasol/toolbox/sphinx/multiversion/__init__.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,11 @@
99
We also took some patches from `this <https://github.com/samuel-emrys/sphinx-multiversion>`_ which was also published under the BSD license.
1010
1111
So huge thanks to the original author `Jan Holthuis <https://github.com/Holzhaus>`_ and all contributors.
12-
"""
1312
14-
# TODO:
15-
# * add sorting support
16-
# * add gh pages support
17-
# * add command to deploy to gh-pages
18-
# * add support for loading packed version template?
13+
14+
NOTE:
15+
The original version and its defaults were minimally adjusted to work in Exasol's projects with the defaults and without adding an extra template. The [Shibuya](https://github.com/lepture/shibuya) theme is expected to be used for HTML, which already evaluates the versions field in the HTML context and generates an appropriate selector for the versions.
16+
"""
1917

2018
from exasol.toolbox.version import VERSION
2119
from exasol.toolbox.sphinx.multiversion.main import main

0 commit comments

Comments
 (0)