You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by li...@apache.org on 2022/11/17 13:22:08 UTC
[arrow-adbc] branch main updated: docs: update Sphinx version, theme (#185)
This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-adbc.git
The following commit(s) were added to refs/heads/main by this push:
new 45df493 docs: update Sphinx version, theme (#185)
45df493 is described below
commit 45df4935df3b673996c371bd265c0eb32cfd6260
Author: David Li <li...@gmail.com>
AuthorDate: Thu Nov 17 08:22:03 2022 -0500
docs: update Sphinx version, theme (#185)
---
ci/conda_env_docs.txt | 5 ++---
docs/source/_static/logo-dark.png | Bin 0 -> 22461 bytes
docs/source/_static/logo-light.png | Bin 0 -> 11027 bytes
docs/source/_static/logo.png | Bin 236739 -> 0 bytes
docs/source/conf.py | 18 ++++++++----------
docs/source/python/api/adbc_driver_manager.rst | 20 ++++++++++----------
6 files changed, 20 insertions(+), 23 deletions(-)
diff --git a/ci/conda_env_docs.txt b/ci/conda_env_docs.txt
index 607aaf2..04ee3a5 100644
--- a/ci/conda_env_docs.txt
+++ b/ci/conda_env_docs.txt
@@ -17,10 +17,9 @@
breathe
doxygen
+furo
make
numpydoc
-pydata-sphinx-theme>=0.8.0
-sphinx
-sphinx-book-theme>=0.3.0
+sphinx>=5.0
sphinx-copybutton
sphinx-design
diff --git a/docs/source/_static/logo-dark.png b/docs/source/_static/logo-dark.png
new file mode 100644
index 0000000..1cf65f0
Binary files /dev/null and b/docs/source/_static/logo-dark.png differ
diff --git a/docs/source/_static/logo-light.png b/docs/source/_static/logo-light.png
new file mode 100644
index 0000000..ccf6c61
Binary files /dev/null and b/docs/source/_static/logo-light.png differ
diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png
deleted file mode 100644
index 1fd89d9..0000000
Binary files a/docs/source/_static/logo.png and /dev/null differ
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 10457c0..806bf84 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -18,10 +18,10 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-project = "Apache Arrow ADBC"
+project = "ADBC"
copyright = "2022, Apache Arrow Developers"
author = "the Apache Arrow Developers"
-release = "1.0.0a0"
+release = "0.1.0 (dev)"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -59,15 +59,13 @@ breathe_projects = {
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-html_logo = "_static/logo.png"
-html_theme = "sphinx_book_theme"
+html_theme = "furo"
html_theme_options = {
- "path_to_docs": "docs",
- "repository_branch": "main",
- "repository_url": "https://github.com/apache/arrow-adbc",
- "use_edit_page_button": True,
- "use_issues_button": True,
- "use_repository_button": True,
+ "dark_logo": "logo-dark.png",
+ "light_logo": "logo-light.png",
+ "source_repository": "https://github.com/apache/arrow-adbc/",
+ "source_branch": "main",
+ "source_directory": "docs/source/",
}
html_static_path = ["_static"]
diff --git a/docs/source/python/api/adbc_driver_manager.rst b/docs/source/python/api/adbc_driver_manager.rst
index 96414e3..231b561 100644
--- a/docs/source/python/api/adbc_driver_manager.rst
+++ b/docs/source/python/api/adbc_driver_manager.rst
@@ -123,13 +123,13 @@ Classes
Exceptions
==========
-.. autoexception:: DatabaseError
-.. autoexception:: DataError
-.. autoexception:: Error
-.. autoexception:: IntegrityError
-.. autoexception:: InterfaceError
-.. autoexception:: InternalError
-.. autoexception:: NotSupportedError
-.. autoexception:: OperationalError
-.. autoexception:: ProgrammingError
-.. autoexception:: Warning
+.. autoexception:: adbc_driver_manager.DatabaseError
+.. autoexception:: adbc_driver_manager.DataError
+.. autoexception:: adbc_driver_manager.Error
+.. autoexception:: adbc_driver_manager.IntegrityError
+.. autoexception:: adbc_driver_manager.InterfaceError
+.. autoexception:: adbc_driver_manager.InternalError
+.. autoexception:: adbc_driver_manager.NotSupportedError
+.. autoexception:: adbc_driver_manager.OperationalError
+.. autoexception:: adbc_driver_manager.ProgrammingError
+.. autoexception:: adbc_driver_manager.Warning