From 718ae551960c1ac984188d90a500bbc64eb8b3d8 Mon Sep 17 00:00:00 2001 From: dalthviz <16781833+dalthviz@users.noreply.github.com> Date: Wed, 22 Nov 2023 16:37:45 -0500 Subject: [PATCH 1/6] Update readthedocs config to version 2 --- readthedocs.yml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/readthedocs.yml b/readthedocs.yml index 9d944f16..74cb5570 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,5 +1,9 @@ +version: 2 + +build: + os: "ubuntu-22.04" + tools: + python: "mambaforge-22.9" + conda: - file: docs/environment.yml -python: - version: 3 - setup_py_install: true + environment: docs/environment.yml \ No newline at end of file From 789ed99b75a2cd94350bc28e7e7786a056634f7d Mon Sep 17 00:00:00 2001 From: dalthviz <16781833+dalthviz@users.noreply.github.com> Date: Wed, 22 Nov 2023 16:57:24 -0500 Subject: [PATCH 2/6] Add sphinx section to readthedocs config --- readthedocs.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/readthedocs.yml b/readthedocs.yml index 74cb5570..080ffb2b 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -6,4 +6,9 @@ build: python: "mambaforge-22.9" conda: - environment: docs/environment.yml \ No newline at end of file + environment: docs/environment.yml + +sphinx: + builder: html + configuration: docs/source/conf.py + fail_on_warning: true \ No newline at end of file From 70809249c889c3dae5a5b0e99d11c4f9a6323538 Mon Sep 17 00:00:00 2001 From: dalthviz <16781833+dalthviz@users.noreply.github.com> Date: Wed, 22 Nov 2023 17:06:52 -0500 Subject: [PATCH 3/6] Add config to install package for the docs build --- docs/source/conf.py | 2 +- readthedocs.yml | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index e6196af0..275a3ce0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -89,7 +89,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: diff --git a/readthedocs.yml b/readthedocs.yml index 080ffb2b..23e47fc8 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -8,6 +8,11 @@ build: conda: environment: docs/environment.yml +python: + install: + - method: pip + path: . + sphinx: builder: html configuration: docs/source/conf.py From 565fc02295380465bd5ea103fc3cbffbf737bfd4 Mon Sep 17 00:00:00 2001 From: dalthviz <16781833+dalthviz@users.noreply.github.com> Date: Wed, 22 Nov 2023 17:12:45 -0500 Subject: [PATCH 4/6] Update intersphinx_mapping config --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 275a3ce0..6c16c1b8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -310,4 +310,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)} From 76d9909796958c32bf8a9ea5eac10a865a98a6ae Mon Sep 17 00:00:00 2001 From: dalthviz <16781833+dalthviz@users.noreply.github.com> Date: Wed, 22 Nov 2023 17:20:15 -0500 Subject: [PATCH 5/6] Use readthedocs sphinx theme --- docs/environment.yml | 1 + docs/source/conf.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) 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 6c16c1b8..7a97af1b 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 @@ -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 From 5eb3947773240f1a94abe2e7e9e905f7b49eb315 Mon Sep 17 00:00:00 2001 From: dalthviz <16781833+dalthviz@users.noreply.github.com> Date: Wed, 22 Nov 2023 17:28:15 -0500 Subject: [PATCH 6/6] Update copyright --- docs/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7a97af1b..ce2f9c99 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -73,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