Merge pull request #1296 from dolfinus/fix_docs

Fix documentation issues

Author: consideRatio

CONTRIBUTING.md

@@ -339,7 +339,7 @@ VM underneath.
 This git repository contains `pytest` based tests that you can run locally.
 Depending on your development setup, you may want to run different kind of
 tests. You can get some hints on what tests to run and how by inspecting
-`.travis.yaml`.
+`.github`.
 
 ### Environment variables influencing tests
 - `BINDER_URL`: An address of an already running BinderHub as reachable from the

binderhub/tests/conftest.py

@@ -34,7 +34,6 @@
 K8S_NAMESPACE = subprocess.check_output([
     "kubectl", "config", "view", "--minify", "--output", "jsonpath={..namespace}"
 ], text=True).strip() or "default"
-ON_TRAVIS = os.environ.get('TRAVIS')
 
 # set BINDER_URL to run tests against an already-running binderhub
 # this will skip launching BinderHub internally in the app fixture
@@ -145,8 +144,6 @@ def _binderhub_config():
     except Exception:
         cfg.BinderHub.builder_required = False
         K8S_AVAILABLE = False
-        if ON_TRAVIS:
-            pytest.fail("Kubernetes should be available on Travis")
     else:
         K8S_AVAILABLE = True
     if REMOTE_BINDER:
@@ -157,8 +154,6 @@ def _binderhub_config():
         requests.get(cfg.BinderHub.hub_url, timeout=5, allow_redirects=False)
     except Exception as e:
         print(f"JupyterHub not available at {cfg.BinderHub.hub_url}: {e}")
-        if ON_TRAVIS:
-            pytest.fail("JupyterHub should be available on Travis")
         cfg.BinderHub.hub_url = ''
     else:
         print(f"JupyterHub available at {cfg.BinderHub.hub_url}")

doc/developer/repoproviders.rst

@@ -30,9 +30,9 @@ Currently supported providers, their prefixes and specs are:
     +------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
     | Zenodo     | ``zenodo``         | ``<zenodo-DOI>``                                            | `Zenodo <https://zenodo.org/>`_ is a non-profit provider of scholarly artifacts (such as code repositories) run in partnership with CERN. |
     +------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-    | Figshare   | ``figshare``       | ``<figshare-DOI>``                                          | `FigShare <https://figshare.com/>`_ is a company that offers hosting for scholarly artifacts (such as code repositories).                   |
+    | Figshare   | ``figshare``       | ``<figshare-DOI>``                                          | `FigShare <https://figshare.com/>`_ is a company that offers hosting for scholarly artifacts (such as code repositories).                 |
     +------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-    | HydroShare | ``hydroshare``     | ``<hydroshare-DOI-or-ResourceID>``                          | `HydroShare <https://www.hydroshare.org/>`_ is a hydrologic information system for users to share and publish data and models.                 |
+    | HydroShare | ``hydroshare``     | ``<hydroshare-DOI-or-ResourceID>``                          | `HydroShare <https://www.hydroshare.org/>`_ is a hydrologic information system for users to share and publish data and models.            |
     +------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
     | Dataverse  | ``dataverse``      | ``<dataverse-DOI>``                                         | `Dataverse <https://dataverse.org/>`_ is open source research data repository software installed all over the world.                      |
     +------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+

doc/doc-requirements.txt

@@ -9,6 +9,7 @@
 # environment, which it is on ReadTheDocs.
 
 # Documentation specific packages
+https://github.com/jupyterhub/autodoc-traits/archive/75885ee24636efbfebfceed1043459715049cd84.zip
 myst-parser
 pydata-sphinx-theme
 sphinx-copybutton