docs: change the html theme to "furo"

PR Closed: #1061
Graviti-AI · Dec 28, 2021 · 3094c33 · 3094c33
1 parent 8c6b192
commit 3094c33
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 6 deletions.
diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml
@@ -39,7 +39,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme
+          pip install sphinx furo
           pip install -r requirements.txt
 
       - name: Build docs

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,15 @@
+#
+# Copyright 2021 Graviti. Licensed under MIT License.
+#
+
+---
+version: 2
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  version: "3.8"
+  install:
+    - requirements: requirments_docs.txt
+    - requirements: requirements.txt
diff --git a/docs/source/advanced_features/request_configuration.rst b/docs/source/advanced_features/request_configuration.rst
@@ -9,7 +9,6 @@ Note that the default settings can satisfy most use cases.
 .. _request_config_table:
 
 .. table:: Requests Configuration Tables
-   :align: center
    :widths: auto
 
    ===================== ======================================================================================
@@ -41,4 +40,4 @@ Usage
 .. literalinclude:: ../../../docs/code/request_configuration.py
    :language: python
    :start-after: """Example of request config"""
-   :end-before: """"""
+   :end-before: """"""
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -71,7 +71,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 html_favicon = "images/favicon.svg"
 
 

diff --git a/docs/source/quick_start/examples/index.rst b/docs/source/quick_start/examples/index.rst
@@ -7,7 +7,6 @@ The following table lists a series of examples to help developers to use TensorB
 .. _examples_table:
 
 .. table:: Examples
-   :align: center
    :widths: auto
 
    ====================================================================== =========================================================================

diff --git a/docs/source/tensorbay_cli/cli_commands.rst b/docs/source/tensorbay_cli/cli_commands.rst
@@ -7,7 +7,6 @@ The following table lists the currently supported CLI commands.(:numref:`Table.
 .. _cli_commands_table:
 
 .. table:: CLI Commands
-   :align: center
    :widths: auto
 
    =======================================================  ===========================================================

diff --git a/requirments_docs.txt b/requirments_docs.txt
@@ -0,0 +1,6 @@
+#
+# Copyright 2021 Graviti. Licensed under MIT License.
+#
+
+furo >= 2021.11.23
+sphinx == 4.2.0