diff --git a/docs/_static/astroquery_logo_dark.svg b/docs/_static/astroquery_logo_dark.svg
new file mode 100644
index 0000000000..68839cd0d6
--- /dev/null
+++ b/docs/_static/astroquery_logo_dark.svg
@@ -0,0 +1,294 @@
+
+
+
+
diff --git a/docs/_static/astroquery_logo_light.svg b/docs/_static/astroquery_logo_light.svg
new file mode 100644
index 0000000000..10a2eb5a74
--- /dev/null
+++ b/docs/_static/astroquery_logo_light.svg
@@ -0,0 +1,293 @@
+
+
+
+
diff --git a/docs/conf.py b/docs/conf.py
index 2178e00ff4..78ee3c1b7d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -19,7 +19,7 @@
# Load all of the global Astropy configuration
try:
- from sphinx_astropy.conf.v1 import * # noqa
+ from sphinx_astropy.conf.v3 import * # noqa
except ImportError:
print('ERROR: the documentation requires the sphinx-astropy package to '
'be installed')
@@ -80,19 +80,6 @@
# -- Options for HTML output ---------------------------------------------------
-# A NOTE ON HTML THEMES
-# The global astropy configuration uses a custom theme, 'bootstrap-astropy',
-# which is installed along with astropy. A different theme can be used or
-# the options for this theme can be modified by overriding some of the
-# variables set in the global configuration. The variables set in the
-# global configuration are listed below, commented out.
-
-html_theme_options = {
- 'logotext1': 'astro', # white, semi-bold
- 'logotext2': 'query', # orange, light
- 'logotext3': ':docs', # white, light
-}
-
# Add any paths that contain custom themes here, relative to this directory.
# To use a different custom theme, add the directory containing the theme.
# html_theme_path = []
@@ -121,6 +108,12 @@
# Output file base name for HTML help builder.
htmlhelp_basename = project + 'doc'
+html_theme_options = {
+ "logo": {
+ "image_light": "_static/astroquery_logo_light.svg",
+ "image_dark": "_static/astroquery_logo_dark.svg",
+ }
+}
# -- Options for LaTeX output --------------------------------------------------
@@ -140,30 +133,6 @@
# Setting this URL is requited by sphinx-astropy
github_issues_url = 'https://github.com/astropy/astroquery/issues/'
-
-
-# read the docs mocks
-class Mock(object):
- def __init__(self, *args, **kwargs):
- pass
-
- def __call__(self, *args, **kwargs):
- return Mock()
-
- @classmethod
- def __getattr__(cls, name):
- if name in ('__file__', '__path__'):
- return '/dev/null'
- elif name[0] == name[0].upper():
- return type(name, (), {})
- else:
- return Mock()
-
-
-MOCK_MODULES = ['atpy', 'beautifulsoup4', 'vo', 'lxml', 'keyring', 'bs4']
-for mod_name in MOCK_MODULES:
- sys.modules[mod_name] = Mock()
-
nitpicky = True
nitpick_ignore = [('py:class', 'astroquery.mast.core.MastQueryWithLogin'),
# astropy interited type annotations
diff --git a/pyproject.toml b/pyproject.toml
index bbe6c2c6cd..b074e20b5b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -51,7 +51,7 @@ docs = [
# https://github.com/astropy/astroquery/issues/3102
"sphinx-automodapi",
"matplotlib",
- "sphinx-astropy>=1.5",
+ "sphinx-astropy[confv3]>=1.11",
"scipy",
"fsspec[http]",
]
diff --git a/tox.ini b/tox.ini
index ca7173cf23..9fae23de67 100644
--- a/tox.ini
+++ b/tox.ini
@@ -89,7 +89,7 @@ description = Building the narrative and API docs
extras = docs, all
commands =
python -m pip freeze
- sphinx-build -W . _build/html
+ sphinx-build -W . _build/html {posargs}
[testenv:linkcheck]
@@ -98,4 +98,4 @@ description = check the links in the HTML docs
extras = docs, all
commands =
python -m pip freeze
- sphinx-build -W --keep-going -b linkcheck . _build/html
+ sphinx-build -W --keep-going -b linkcheck . _build/html {posargs}