chore: merge pull request #37 from threeal/docs-use-furo-theme

Update Documentation Theme to Furo
threeal · Jul 11, 2023 · bfc7457 · bfc7457
2 parents bcdd619 + 31c2ed2
commit bfc7457
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # Overview
 
 [![build status](https://img.shields.io/github/actions/workflow/status/threeal/cpp/build.yml?branch=main)](https:/threeal/cpp/actions/workflows/build.yml)
+[![deploy status](https://img.shields.io/github/actions/workflow/status/threeal/cpp/deploy.yaml?branch=main&label=deploy)](https:/threeal/cpp/actions/workflows/deploy.yaml)
 
 A comprehensive collection of [C++](https://isocpp.org/) utility packages.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -12,5 +12,5 @@
 breathe_projects = {"error": "../error/build/docs"}
 breathe_default_project = "error"
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 html_static_path = ['_static']
diff --git a/docs/error/index.rst b/docs/error/index.rst
@@ -21,6 +21,13 @@ License
 -------
 
 .. image:: https://opensource.org/wp-content/uploads/2022/10/osi-badge-dark.svg
+ :class: only-light
+ :width: 150
+ :align: right
+ :target: https://opensource.org/licenses
+
+.. image:: https://opensource.org/wp-content/uploads/2022/10/osi-badge-light.svg
+ :class: only-dark
  :width: 150
  :align: right
  :target: https://opensource.org/licenses

diff --git a/docs/index.rst b/docs/index.rst
@@ -17,6 +17,13 @@ License
 -------
 
 .. image:: https://opensource.org/wp-content/uploads/2022/10/osi-badge-dark.svg
+ :class: only-light
+ :width: 150
+ :align: right
+ :target: https://opensource.org/licenses
+
+.. image:: https://opensource.org/wp-content/uploads/2022/10/osi-badge-light.svg
+ :class: only-dark
  :width: 150
  :align: right
  :target: https://opensource.org/licenses

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,3 @@
 breathe
+furo
 sphinx
-sphinx-rtd-theme