Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
39 changes: 1 addition & 38 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down Expand Up @@ -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 = []
Expand Down Expand Up @@ -140,30 +127,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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]",
]
Expand Down
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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}
Loading