diff --git a/docs/environment.yml b/docs/environment.yml index 34e94eb8..005ef1c6 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -6,3 +6,4 @@ channels: dependencies: - pyqt - qtpy +- sphinx_rtd_theme diff --git a/docs/source/conf.py b/docs/source/conf.py index e6196af0..ce2f9c99 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,6 +43,7 @@ 'sphinx.ext.autosummary', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', + 'sphinx_rtd_theme', ] autosummary_generate = True @@ -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 @@ -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: @@ -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 @@ -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)} diff --git a/readthedocs.yml b/readthedocs.yml index 9d944f16..23e47fc8 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -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 \ No newline at end of file