Update docs (#30)

* replace links to RTD

* fix license and copyright

Author: Chilipp

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  psyplot: psyplot/[email protected].23
+  psyplot: psyplot/[email protected].24
   mattermost-plugin-notify: nathanaelhoun/[email protected]
 
 executors:

CHANGELOG.rst

@@ -11,7 +11,7 @@ Changed
 - psyplot is now officially licensed under LGPL-3.0-only,
   see `#29 <https://github.com/psyplot/psyplot/pull/29>`__
 - Documentation is now hosted with Github Pages at https://psyplot.github.io/psyplot-gui.
-  Redirects from the old documentation at https://psyplot-gui.readthedocs.io have been
+  Redirects from the old documentation at `https://psyplot-gui.readthedocs.io` have been
   configured.
 - We use CicleCI now for a standardized CI/CD pipeline to build and test
   the code and docs all at one place, see `#28 <https://github.com/psyplot/psyplot-gui/pull/28>`__

README.rst

@@ -16,9 +16,9 @@ Graphical User Interface for the psyplot package
     * - implementations
       - |supported-versions| |supported-implementations|
 
-.. |docs| image:: http://readthedocs.org/projects/psyplot-gui/badge/?version=latest
-    :alt: Documentation Status
-    :target: http://psyplot-gui.readthedocs.io/en/latest/?badge=latest
+.. |docs| image:: https://img.shields.io/github/deployments/psyplot/psyplot-gui/github-pages
+    :alt: Documentation
+    :target: http://psyplot.github.io/psyplot-gui/
 
 .. |circleci| image:: https://circleci.com/gh/psyplot/psyplot-gui/tree/master.svg?style=svg
     :alt: CircleCI
@@ -64,10 +64,10 @@ psyplot_ with a graphical user interface using PyQt_. See the homepage of the
 main project on examples on the possibilities with psyplot_.
 
 You can see the full documentation under
-`readthedocs.org <http://psyplot-gui.readthedocs.io/en/latest/?badge=latest>`__
+`psyplot.github.io/psyplot-gui/ <http://psyplot.github.io/psyplot-gui>`__
 
 .. _PyQt: https://riverbankcomputing.com/software/pyqt/intro
-.. _psyplot: http://psyplot.readthedocs.io/en/latest/
+.. _psyplot: http://psyplot.github.io/
 
 
 Copyright

docs/conf.py

@@ -118,8 +118,6 @@
 
 html_theme = 'sphinx_rtd_theme'
 
-# otherwise, readthedocs.org uses their theme by default, so no need to specify
-
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".

docs/getting_started.rst

@@ -94,7 +94,7 @@ If you do not wish this behaviour, set the ``console.auto_set_mp`` and
 
 .. |ipython_console| image:: ipython_console.png
 
-.. _IPython: http://ipython.readthedocs.io/en/stable/
+.. _IPython: https://ipython.readthedocs.io/en/stable/
 .. _qtconsole: https://qtconsole.readthedocs.io/en/stable/
 .. _Spyder: https://www.spyder-ide.org/
 

docs/index.rst

@@ -24,9 +24,9 @@ main project on examples on the possibilities with psyplot_.
         * - implementations
           - |supported-versions| |supported-implementations|
 
-    .. |docs| image:: http://readthedocs.org/projects/psyplot-gui/badge/?version=latest
-        :alt: Documentation Status
-        :target: http://psyplot-gui.readthedocs.io/en/latest/?badge=latest
+    .. |docs| image:: https://img.shields.io/github/deployments/psyplot/psyplot-gui/github-pages
+        :alt: Documentation
+        :target: http://psyplot.github.io/psyplot-gui/
 
     .. |circleci| image:: https://circleci.com/gh/psyplot/psyplot-gui/tree/master.svg?style=svg
         :alt: CircleCI

docs/installing.rst

@@ -41,17 +41,12 @@ built upon multiple other packages, namely
 - fasteners_: Which provides an inprocess lock to communicate to the psyplot
   mainwindow
 - PyQt5_: Python bindings to the Qt_ software
-
-Optional dependencies
-^^^^^^^^^^^^^^^^^^^^^
-We furthermore recommend to use
-
 - sphinx_>=1.3.5: To use all features of the interactive documentation access
 
 .. _conda: https://docs.conda.io/en/latest/
 .. _psyplot: https://psyplot.github.io/psyplot/installing.html
 .. _qtconsole: https://qtconsole.readthedocs.io/en/latest/
-.. _fasteners: http://fasteners.readthedocs.org/en/latest/index.html
+.. _fasteners: https://fasteners.readthedocs.org/en/latest/index.html
 .. _sphinx: https://www.sphinx-doc.org/en/master/index.html
 .. _PyQt5: https://www.riverbankcomputing.com/static/Docs/PyQt5/installation.html
 .. _Qt: https://www.qt.io/

psyplot_gui/__init__.py

@@ -57,12 +57,16 @@
 from psyplot.compat.pycompat import get_default_value
 
 __author__ = "Philipp S. Sommer"
-__copyright__ = "Copyright 2016 - 2020, Philipp S. Sommer"
+__copyright__ = """
+Copyright (C) 2021 Helmholtz-Zentrum Hereon
+Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht
+Copyright (C) 2016-2021 University of Lausanne
+"""
 __credits__ = ["Philipp S. Sommer"]
-__license__ = "GPL-2.0-only"
+__license__ = "LGPL-3.0-only"
 
 __maintainer__ = "Philipp S. Sommer"
-__email__ = "philipp.sommer@hzg.de"
+__email__ = "psyplot@hereon.de"
 
 __status__ = "Production"
 
@@ -456,19 +460,13 @@ def get_parser(create=True):
 UNIT_TESTING = os.getenv('CI')
 
 
-#: Disable the default for the ListGuiPluginsAction on RTD, because it looks
-#: better in the docs
-_on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-
-
 class ListGuiPluginsAction(argparse.Action):
 
     def __init__(self, option_strings, dest=argparse.SUPPRESS, nargs=None,
                  default=argparse.SUPPRESS, **kwargs):
         if nargs is not None:
             raise ValueError("nargs not allowed")
-        if not _on_rtd:
-            kwargs['default'] = default
+        kwargs['default'] = default
         super(ListGuiPluginsAction, self).__init__(
             option_strings, nargs=0, dest=dest,
             **kwargs)

psyplot_gui/help_explorer.py

@@ -165,7 +165,7 @@ class UrlBrowser(QFrame):
 
     doc_urls = OrderedDict([
         ('startpage', 'https://startpage.com/'),
-        ('psyplot', 'http://psyplot.readthedocs.org/en/latest/'),
+        ('psyplot', 'http://psyplot.github.io/psyplot/'),
         ('pyplot', 'http://matplotlib.org/api/pyplot_api.html'),
         ('seaborn', 'http://stanford.edu/~mwaskom/software/seaborn/api.html'),
         ('cartopy', 'http://scitools.org.uk/cartopy/docs/latest/index.html'),

psyplot_gui/sphinx_supp/conf.py

@@ -151,21 +151,14 @@
     'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
     'xarray': ('https://xarray.pydata.org/en/stable/', None),
     'cartopy': ('https://scitools.org.uk/cartopy/docs/latest/', None),
-    'psyplot': ('https://psyplot.readthedocs.io/en/latest/', None),
-    'psyplot_gui': ('https://psyplot.readthedocs.io/projects/psyplot-gui/en/'
-                    'latest/', None),
-    'psy_maps': ('https://psyplot.readthedocs.io/projects/psy-maps/en/'
-                 'latest/', None),
-    'psy_simple': ('https://psyplot.readthedocs.io/projects/psy-simple/en/'
-                   'latest/', None),
-    'psy_reg': ('https://psyplot.readthedocs.io/projects/psy-reg/en/'
-                'latest/', None),
+    'psyplot': ('https://psyplot.github.io/psyplot/', None),
+    'psyplot_gui': ('https://psyplot.github.io/psyplot-gui/', None),
+    'psy_maps': ('https://psyplot.github.io/psy-maps/', None),
+    'psy_simple': ('https://psyplot.github.io/psy-simple/', None),
+    'psy_view': ('https://psyplot.github.io/psy-view/', None),
+    'psy_reg': ('https://psyplot.github.io/psy-reg/', None),
+    'python': ('https://docs.python.org/3/', None),
 }
-if six.PY3:
-    intersphinx_mapping['python'] = ('https://docs.python.org/3.6/', None)
-else:
-    intersphinx_mapping['python'] = ('https://docs.python.org/2.7/', None)
-
 
 replacements = {
     '`psyplot.rcParams`': '`~psyplot.config.rcsetup.rcParams`',

setup.py

@@ -23,21 +23,10 @@
 # You should have received a copy of the GNU LGPL-3.0 license
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-import os
 import os.path as osp
 from setuptools import setup, find_packages
 from setuptools.command.test import test as TestCommand
 import sys
-
-
-if os.getenv("READTHEDOCS") == "True":
-    # to make versioneer working, we need to unshallow this repo
-    # because RTD does a checkout with --depth 50
-    import subprocess as spr
-    rootdir = osp.dirname(__file__)
-    spr.call(["git", "-C", rootdir, "fetch", "--unshallow", "origin"])
-
-
 import versioneer
 
 
@@ -75,20 +64,21 @@ def run_tests(self):
         'Topic :: Scientific/Engineering :: Visualization',
         'Topic :: Scientific/Engineering :: GIS',
         'Topic :: Scientific/Engineering',
-        'License :: OSI Approved :: GNU General Public License v2 (GPLv2)',
+        'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3 :: Only',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
         'Operating System :: OS Independent',
       ],
       keywords=('visualization netcdf raster cartopy earth-sciences pyqt qt '
                 'ipython jupyter qtconsole'),
       url='https://github.com/psyplot/psyplot-gui',
       author='Philipp S. Sommer',
-      author_email='philipp.sommer@hzg.de',
-      license="GPLv2",
+      author_email='psyplot@hereon.de',
+      license="LGPL-3.0-only",
       packages=find_packages(exclude=['docs', 'tests*', 'examples']),
       install_requires=[
           'psyplot>=1.3.0',
@@ -105,7 +95,7 @@ def run_tests(self):
           osp.join('psyplot_gui', 'icons', '*.svg'),
           ]},
       project_urls={
-          'Documentation': 'https://psyplot.readthedocs.io/projects/psyplot-gui',
+          'Documentation': 'https://psyplot.github.io/psyplot-gui',
           'Source': 'https://github.com/psyplot/psyplot-gui',
           'Tracker': 'https://github.com/psyplot/psyplot-gui/issues',
       },