fix(docs): Break long lines for better readability within tables

apache · Dec 19, 2023 · 74acc72 · 74acc72
1 parent 584a721
commit 74acc72
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 6 deletions.
diff --git a/src/docs/src/api/database/find.rst b/src/docs/src/api/database/find.rst
@@ -12,9 +12,9 @@
 
 .. _api/db/_find:
 
-================
+===============
 ``/{db}/_find``
-================
+===============
 
 .. http:post:: /{db}/_find
  :synopsis: Find documents within a given database.
@@ -683,7 +683,7 @@ operators require the argument to be in a specific JSON format.
 | | ``$lte`` | Any JSON | The field is less than or equal to |
 | | | | the argument. |
 +---------------+-----------------+-------------+------------------------------------+
-| | ``$eq`` | Any JSON | The field is equal to the argument |
+| | ``$eq`` | Any JSON | The field is equal to the argument.|
 +---------------+-----------------+-------------+------------------------------------+
 | | ``$ne`` | Any JSON | The field is not equal to the |
 | | | | argument. |
@@ -692,7 +692,7 @@ operators require the argument to be in a specific JSON format.
 | | | | to the argument. |
 +---------------+-----------------+-------------+------------------------------------+
 | | ``$gt`` | Any JSON | The field is greater than the |
-| | | | to the argument. |
+| | | | argument.  |
 +---------------+-----------------+-------------+------------------------------------+
 | Object | ``$exists`` | Boolean | Check whether the field exists or |
 | | | | not, regardless of its value. |
@@ -731,7 +731,7 @@ operators require the argument to be in a specific JSON format.
 | | | | the Perl Compatible Regular |
 | | | | Expression (PCRE) library. For |
 | | | | more information about what is |
-| | | | implemented, see the see the |
+| | | | implemented, see the   |
 | | | | `Erlang Regular Expression |
 | | | | <http:https://erlang.org/doc |
 | | | | /man/re.html>`_. |

diff --git a/src/docs/src/conf.py b/src/docs/src/conf.py
@@ -112,3 +112,4 @@
 
 def setup(app):
  app.add_css_file("css/rtd_theme.css")
+ app.add_css_file("css/tablefix.css")
diff --git a/src/docs/static/css/rtd_theme.css b/src/docs/static/css/rtd_theme.css
@@ -57,4 +57,4 @@ span.linkdescr {
 
 ul.simple {
  margin-bottom: 2ex !important; /* dirty but necessary hack */
-}
+}
diff --git a/src/docs/static/css/tablefix.css b/src/docs/static/css/tablefix.css
@@ -0,0 +1,26 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http:https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+/* Reference https://github.com/readthedocs/sphinx_rtd_theme/issues/117 */
+/* override table width restrictions */
+.wy-table-responsive table td,
+.wy-table-responsive table th {
+ white-space: normal;
+}
+
+.wy-table-responsive {
+ margin-bottom: 24px;
+ max-width: 100%;
+ overflow: visible;
+}