Update docs (#29)

* fix broken links

* add job to test the docs

* fix links to RTD

* remove RTD config

* remove sphinx_nbexamples

* add coverage test

* use [email protected]

* fix email

Author: Chilipp

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  psyplot: psyplot/[email protected].19
+  psyplot: psyplot/[email protected].24
   mattermost-plugin-notify: nathanaelhoun/[email protected]
 
 executors:
@@ -50,17 +50,25 @@ workflows:
           name: test-matplotlib-latest
           parallelism: << pipeline.parameters.parallelism >>
           run-job: << pipeline.parameters.test-matplotlib-latest >>
+          pytest_args: --cov=psy_simple
           build_refs: true
           requires:
             - install
       - psyplot/test-parallel:
           name: test-matplotlib-3.3
           parallelism: << pipeline.parameters.parallelism >>
           run-job: << pipeline.parameters.test-matplotlib-3_3 >>
+          pytest_args: --cov=psy_simple
           build_refs: true
           packages: matplotlib=3.3
           requires:
             - install
+      - psyplot/build-docs:
+          name: test-docs
+          run-job: << pipeline.parameters.build_docs >>
+          builders: linkcheck
+          requires:
+            - install
       - mattermost-plugin-notify/approval-notification:
           name: notify-deploy
           context: mattermost
@@ -70,6 +78,7 @@ workflows:
           requires:
             - test-matplotlib-latest
             - test-matplotlib-3.3
+            - test-docs
       - hold-for-deploy:
           type: approval
           requires:

CHANGELOG.rst

@@ -99,7 +99,7 @@ Added
 -----
 * Changelog
 * ``interp_bounds`` formatoption for the ``plot2d`` plot method (see the
-  `docs <https://psyplot.readthedocs.io/projects/psy-simple/en/latest/api/psy_simple.plotters.html#psy_simple.plotters.Simple2DPlotter.interp_bounds>`__)
+  `docs <https://psyplot.github.io/psy-simple/api/psy_simple.plotters.html#psy_simple.plotters.Simple2DPlotter.interp_bounds>`__)
 * Added the ``fldmean`` plot method that can be used to directly calculate and
   plot the mean over the x- and y-dimensions
 

README.rst

@@ -17,9 +17,9 @@ psy-simple: The psyplot plugin for simple visualizations
     * - implementations
       - |supported-versions| |supported-implementations|
 
-.. |docs| image:: http://readthedocs.org/projects/psy-simple/badge/?version=latest
-    :alt: Documentation Status
-    :target: http://psy-simple.readthedocs.io/en/latest/?badge=latest
+.. |docs| image:: https://img.shields.io/github/deployments/psyplot/psy-simple/github-pages
+    :alt: Documentation
+    :target: http://psyplot.github.io/psy-simple/
 
 .. |circleci| image:: https://circleci.com/gh/psyplot/psy-simple/tree/master.svg?style=svg
     :alt: CircleCI
@@ -70,21 +70,18 @@ It provides the basics for all the more advanced and specialized plugins like
 the psy-maps_ or psy-reg_ plugin.
 
 See the full documentation on
-`readthedocs.org <http://psyplot.readthedocs.io/projects/psy-simple>`__ for all
-`plot methods`_ and examples_.
+`psyplot.github.io/psy-simple/ <http://psyplot.github.io/psy-simple>`__ for all
+`plot methods`_, and checkout the examples_.
 
-.. _psy-maps: http://psyplot.readthedocs.io/projects/psy-maps/
-.. _psy-reg: http://psyplot.readthedocs.io/projects/psy-reg/
-.. _plot methods: http://psyplot.readthedocs.io/projects/psy-simple/en/latest/plot_methods
-.. _examples: http://psyplot.readthedocs.io/projects/psy-simple/en/latest/examples
+.. _psy-maps: http://psyplot.github.io/psy-maps/
+.. _psy-reg: http://psyplot.github.io/psy-reg/
+.. _plot methods: http://psyplot.github.io/psy-simple/plot_methods
+.. _examples: http://psyplot.github.io/examples/
 
 Copyright
 ---------
-Copyright (C) 2021 Helmholtz-Zentrum Hereon
-
-Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht
-
-Copyright (C) 2016-2021 University of Lausanne
+Copyright © 2021 Helmholtz-Zentrum Hereon, 2020-2021 Helmholtz-Zentrum
+Geesthacht, 2016-2021 University of Lausanne
 
 This file is part of psy-simple and is released under the GNU LGPL-3.O license.
 See COPYING and COPYING.LESSER in the root of the repository for full
@@ -100,4 +97,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU LGPL-3.0 license for more details.
 
 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/>.
+along with this program.  If not, see https://www.gnu.org/licenses/.

docs/conf.py

@@ -70,25 +70,15 @@
     'IPython.sphinxext.ipython_directive',
     'psyplot.sphinxext.extended_napoleon',
     'autodocsumm',
-    'sphinx_nbexamples',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-# on_rtd is whether we are on readthedocs.org, this line of code grabbed from
-# docs.readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-
 # process the examples if they don't exist already
 process_examples = (
     not osp.exists(osp.join(osp.dirname(__file__), 'examples')))
 
-if on_rtd:
-    spr.call([sys.executable] +
-             ('-m ipykernel install --user --name python3 '
-              '--display-name python3').split())
-
 if not osp.exists(osp.join(osp.dirname(__file__), 'api')):
     spr.check_call(['bash', 'apigen.bash'])
 
@@ -164,18 +154,13 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-    # 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".
-    html_static_path = ['_static']
+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".
+html_static_path = ['_static']
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'psy-simpledoc'
@@ -231,23 +216,18 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None),
+    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
-    'matplotlib': ('http://matplotlib.org/', None),
-    'sphinx': ('http://www.sphinx-doc.org/en/stable/', None),
-    'xarray': ('http://xarray.pydata.org/en/stable/', None),
-    'cartopy': ('http://scitools.org.uk/cartopy/docs/latest/', None),
-    'mpl_toolkits': ('http://matplotlib.org/basemap/', None),
-    'psyplot': ('https://psyplot.readthedocs.io/en/dev', None),
-    'psy_maps': (
-        'https://psyplot.readthedocs.io/projects/psy-maps/en/latest/', None),
-    'psy_reg': ('https://psyplot.readthedocs.io/projects/psy-reg/en/latest/',
-                None),
+    'matplotlib': ('https://matplotlib.org/stable/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
+    'xarray': ('https://xarray.pydata.org/en/stable/', None),
+    'cartopy': ('https://scitools.org.uk/cartopy/docs/latest/', None),
+    'mpl_toolkits': ('https://matplotlib.org/basemap/', None),
+    'psyplot': ('https://psyplot.github.io/psyplot/', None),
+    'psy_maps': ('https://psyplot.github.io/psy-maps/', 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.7/', None)
-else:
-    intersphinx_mapping['python'] = ('https://docs.python.org/2.7/', None)
 
 
 def group_formatoptions(app, what, name, obj, section, parent):

docs/environment.yml

@@ -13,5 +13,4 @@ dependencies:
     - psy-simple
     - psyplot-gui
     - autodocsumm
-    - sphinx-nbexamples
     - pip

docs/index.rst

@@ -16,8 +16,8 @@ the psy-maps_ or psy-reg_ plugin.
 See the :ref:`plot_methods` and :ref:`gallery_examples` for more information.
 
 
-.. _psy-maps: http://psyplot.readthedocs.io/projects/psy-maps/
-.. _psy-reg: http://psyplot.readthedocs.io/projects/psy-reg/
+.. _psy-maps: http://psyplot.github.io/psy-maps/
+.. _psy-reg: http://psyplot.github.io/psy-reg/
 
 .. start-badges
 
@@ -30,15 +30,15 @@ See the :ref:`plot_methods` and :ref:`gallery_examples` for more information.
         * - docs
           - |docs|
         * - tests
-          - |circleci| |appveyor| |requires| |codecov|
+          - |circleci| |appveyor| |codecov|
         * - package
           - |version| |conda| |github| |zenodo|
         * - implementations
           - |supported-versions| |supported-implementations|
 
-    .. |docs| image:: http://readthedocs.org/projects/psy-simple/badge/?version=latest
-        :alt: Documentation Status
-        :target: http://psy-simple.readthedocs.io/en/latest/?badge=latest
+    .. |docs| image:: https://img.shields.io/github/deployments/psyplot/psy-simple/github-pages
+        :alt: Documentation
+        :target: http://psyplot.github.io/psy-simple/
 
     .. |circleci| image:: https://circleci.com/gh/psyplot/psy-simple/tree/master.svg?style=svg
         :alt: CircleCI
@@ -52,10 +52,6 @@ See the :ref:`plot_methods` and :ref:`gallery_examples` for more information.
         :alt: Coverage
         :target: https://codecov.io/gh/psyplot/psy-simple
 
-    .. |requires| image:: https://requires.io/github/psyplot/psy-simple/requirements.svg?branch=master
-        :alt: Requirements Status
-        :target: https://requires.io/github/psyplot/psy-simple/requirements/?branch=master
-
     .. |version| image:: https://img.shields.io/pypi/v/psy-simple.svg?style=flat
         :alt: PyPI Package latest release
         :target: https://pypi.python.org/pypi/psy-simple
@@ -91,12 +87,33 @@ Documentation
 
     installing
     plot_methods
-    examples/index
     contribute
     api/psy_simple
     changelog
 
 
+Copyright
+---------
+Copyright © 2021 Helmholtz-Zentrum Hereon, 2020-2021 Helmholtz-Zentrum
+Geesthacht, 2016-2021 University of Lausanne
+
+This file is part of psy-simple and is released under the GNU LGPL-3.O license.
+See COPYING and COPYING.LESSER in the root of the repository for full
+licensing details.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License version 3.0 as
+published by the Free Software Foundation.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU LGPL-3.0 license for more details.
+
+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/.
+
+
 
 Indices and tables
 ==================

docs/installing.rst

@@ -11,12 +11,12 @@ How to install
 Installation using conda
 ^^^^^^^^^^^^^^^^^^^^^^^^
 We highly recommend to use conda_ for installing psy-simple. After downloading
-the installer from anaconda_, you can install psy-simple simply via::
+the `miniconda installer`_, you can install psy-simple simply via::
 
     $ conda install -c conda-forge psy-simple
 
-.. _anaconda: https://www.continuum.io/downloads
-.. _conda: http://conda.io/
+.. _miniconda installer: https://conda.io/en/latest/miniconda.html
+.. _conda: https://docs.conda.io/en/latest/
 
 Installation using pip
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -37,5 +37,5 @@ First, clone the github_ repository, and install psy-simple and pytest_. Then
 
     $ pytest
 
-.. _pytest: https://pytest.org/latest/contents.html
+.. _pytest: https://pytest.org/en/latest/contents.html
 .. _github: https://github.com/psyplot/psy-simple

psy_simple/__init__.py

@@ -37,7 +37,7 @@
 __license__ = "LGPL-3.0-only"
 
 __maintainer__ = "Philipp S. Sommer"
-__email__ = "philipp.sommer@hereon.de"
+__email__ = "psyplot@hereon.de"
 
 __status__ = "Production"