Skip to content

Commit 809d776

Browse files
Nicorettitomuben
andauthored
Improve documentation (#272)
--------- Co-authored-by: Thomas Ubensee <34603111+tomuben@users.noreply.github.com>
1 parent c841c24 commit 809d776

File tree

20 files changed

+28
-1216
lines changed

20 files changed

+28
-1216
lines changed

doc/changes/unreleased.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
## 📚 Documentation
1717

1818
* Added Documentation on Metrics
19+
* Added additional details regarding adjusted sphinx-multiversion
20+
* Restructured documentation
1921

2022
## 🔩 Internal
2123

doc/developer_guide/developer_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010
../design
1111
development
1212
plugins
13-
ideas
13+
modules/modules

doc/developer_guide/ideas.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Modules
44
.. toctree::
55
:maxdepth: 2
66

7+
sphinx/sphinx
78
nox
89
pre_commit_hooks
9-
sphinx/sphinx
1010

File renamed without changes.
File renamed without changes.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
sphinx
2+
=======
3+
4+
sphinx-multiversion
5+
+++++++++++++++++++
6+
7+
The `sphinx-multiversion` extension is a modified copy of `Holzhaus/sphinx-multiversion <https://github.com/Holzhaus/sphinx-multiversion>`_. This copy was taken from version :code:`0.24.0`.
8+
9+
It has been adjusted with minor code changes and modified defaults to work seamlessly with Exasol integration projects, which often require a specific project structure and layout. Additionally, it is designed to be used with an HTML theme that supports displaying and selecting multiple versions if the `versions` variable is set in the HTML context of sphinx. As of this writing, the theme used in conjunction with this modified version of `sphinx-multiversion` is `SHIBUYA <https://github.com/lepture/shibuya>`_, version :code:`2024.10.15`.
10+
11+
.. attention::
12+
13+
**Attribution**
14+
15+
A big thanks to the original author and project `Jan Holthuis <https://github.com/Holzhaus>`_, as well as `Samuel Dowling <https://github.com/samuel-emrys>`_, as we took various patches for the plugin from his fork.
16+
17+
Note: Both projects are published under the `BSD-2 license <https://opensource.org/license/bsd-2-clause>`_.
18+
19+
* https://github.com/sphinx-contrib/multiversion
20+
* https://github.com/samuel-emrys/sphinx-multiversion
21+
22+
.. note::
23+
24+
In the long term, it would be advantageous to remove unnecessary features and code that are not required for Exasol's projects. Adding further tests would also be beneficial. However, the primary goal was to create a low-effort, stable multi-version support solution for our projects.

doc/user_guide/modules/sphinx/multiversion/_templates/versioning.html

Lines changed: 0 additions & 14 deletions
This file was deleted.

doc/user_guide/modules/sphinx/multiversion/changelog.rst

Lines changed: 0 additions & 81 deletions
This file was deleted.

doc/user_guide/modules/sphinx/multiversion/conf.py

Lines changed: 0 additions & 44 deletions
This file was deleted.

0 commit comments

Comments
 (0)