Skip to content

Commit

Permalink
Merge pull request #716 from spacetelescope/test_readthedocs
Browse files Browse the repository at this point in the history
Test readthedocs
  • Loading branch information
obi-wan76 authored Aug 10, 2023
2 parents 130aba7 + 3e1617c commit 68afa59
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 14 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
"sphinx_issues",
"nbsphinx",
"numpydoc",
"astroquery",
]

numpydoc_show_class_members = False
Expand Down
6 changes: 2 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,19 @@ dependencies = [
"pysiaf>=0.19.1",
"soc_roman_tools>=0.1.0",
"synphot>=1.0.0",
"astroquery>=0.4.6",
]

[project.optional-dependencies]
all = [
"astroquery",
]
test = [
"pytest",
"pytest-astropy",
]
docs = [
"nbsphinx",
"sphinx<7.0",
"stsci_rtd_theme",
"sphinx-astropy",
"sphinx_rtd_theme",
"sphinx-automodapi",
"sphinx-issues",
"tomli; python_version <\"3.11\"",
Expand Down
31 changes: 22 additions & 9 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,29 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.9"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
fail_on_warning: false

python:
version: 3.9
install:
- method: pip
path: .
extra_requirements:
- docs
# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Don't build any extra formats
formats: []
# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
1 change: 0 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ basepython= python3.9
passenv= *
deps=
sphinx
sphinx_rtd_theme
stsci_rtd_theme
sphinx-automodapi
sphinx-issues
Expand Down

0 comments on commit 68afa59

Please sign in to comment.