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.

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

PR: Update readthedocs config to version 2 #246

Merged
merged 6 commits into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ channels:
dependencies:
- pyqt
- qtpy
- sphinx_rtd_theme
11 changes: 6 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
'sphinx.ext.autosummary',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx_rtd_theme',
]

autosummary_generate = True
Expand Down Expand Up @@ -72,8 +73,8 @@

# General information about the project.
project = u'qtawesome'
copyright = u'2015, The Spyder Development Team'
author = u'The Spyder Development Team'
copyright = u'2015-, The Spyder Development Team'
author = u'Sylvain Corlay and the Spyder Development Team'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -89,7 +90,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down Expand Up @@ -133,7 +134,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down Expand Up @@ -310,4 +311,4 @@


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
20 changes: 17 additions & 3 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
version: 2

build:
os: "ubuntu-22.04"
tools:
python: "mambaforge-22.9"

conda:
file: docs/environment.yml
environment: docs/environment.yml

python:
version: 3
setup_py_install: true
install:
- method: pip
path: .

sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: true
Loading