Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: change the html theme to "furo" #1061

Merged
merged 1 commit into from
Dec 28, 2021
Merged

docs: change the html theme to "furo" #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build_docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:

- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme
pip install sphinx furo
graczhual marked this conversation as resolved.
Show resolved Hide resolved
pip install -r requirements.txt

- name: Build docs
Expand Down
15 changes: 15 additions & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
3 changes: 1 addition & 2 deletions docs/source/advanced_features/request_configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

===================== ======================================================================================
Expand Down Expand Up @@ -41,4 +40,4 @@ Usage
.. literalinclude:: ../../../docs/code/request_configuration.py
:language: python
:start-after: """Example of request config"""
:end-before: """"""
:end-before: """"""
graczhual marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"


Expand Down
1 change: 0 additions & 1 deletion docs/source/quick_start/examples/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

====================================================================== =========================================================================
Expand Down
1 change: 0 additions & 1 deletion docs/source/tensorbay_cli/cli_commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

======================================================= ===========================================================
Expand Down
6 changes: 6 additions & 0 deletions requirments_docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#
# Copyright 2021 Graviti. Licensed under MIT License.
#

furo >= 2021.11.23
sphinx == 4.2.0