migrate docs to RTD

Author: minrk

.github/workflows/docs.yml

@@ -39,31 +39,3 @@ jobs:
         run: |
           cd docs
           make linkcheck
-
-  build-and-publish:
-    runs-on: ubuntu-22.04
-
-    permissions:
-      # required to push to the gh-pages branch
-      contents: write
-
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.11"
-
-      - name: Install dependencies
-        run: |
-          pip install -r docs/doc-requirements.txt
-
-      - name: make html (Builds documentation)
-        run: |
-          cd docs
-          make html
-
-      - name: Publish to GitHub Pages
-        if: github.ref == 'refs/heads/main'
-        run: |
-          pip install ghp-import
-          ghp-import --no-jekyll --push --message "Update documentation [skip ci]" docs/_build/html

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# Configuration on how ReadTheDocs (RTD) builds our documentation
+# ref: https://readthedocs.org/projects/nbgitpuller/
+# ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
+#
+version: 2
+
+sphinx:
+  configuration: docs/source/conf.py
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/doc-requirements.txt

README.md

@@ -1,19 +1,19 @@
 # [nbgitpuller](https://github.com/jupyterhub/nbgitpuller)
 
 [![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/nbgitpuller/Tests?logo=github&label=tests)](https://github.com/jupyterhub/nbgitpuller/actions)
-[![CircleCI build status](https://img.shields.io/circleci/build/github/jupyterhub/nbgitpuller?logo=circleci&label=docs)](https://circleci.com/gh/jupyterhub/nbgitpuller)
+[![Documentation Status](https://readthedocs.org/projects/nbgitpuller/badge/?version=latest)](https://nbgitpuller.readthedocs.io/en/latest/?badge=latest)
 [![](https://img.shields.io/pypi/v/nbgitpuller.svg?logo=pypi)](https://pypi.python.org/pypi/nbgitpuller)
 [![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/jupyterhub/nbgitpuller/issues)
 [![Discourse](https://img.shields.io/badge/help_forum-discourse-blue?logo=discourse)](https://discourse.jupyter.org/c/jupyterhub)
 [![Gitter](https://img.shields.io/badge/social_chat-gitter-blue?logo=gitter)](https://gitter.im/jupyterhub/jupyterhub)
 
 `nbgitpuller` lets you distribute content in a git repository to your students
 by having them click a simple link. [Automatic
-merging](https://jupyterhub.github.io/nbgitpuller/topic/automatic-merging.html)
+merging](https://nbgitpuller.readthedocs.io/topic/automatic-merging.html)
 ensures that your students are never exposed to `git` directly. It is primarily
 used with a JupyterHub, but can also work on students' local computers.
 
-See [the documentation](https://jupyterhub.github.io/nbgitpuller) for more
+See [the documentation](https://nbgitpuller.readthedocs.io) for more
 information.
 
 ## Installation
@@ -24,10 +24,12 @@ pip install nbgitpuller
 
 ## Example
 
-This example shows how to use the [nbgitpuller link generator](https://jupyterhub.github.io/nbgitpuller/link)
+This example shows how to use the [nbgitpuller link generator]
 to create an nbgitpuller link, which a user then clicks.
 
-1. The [nbgitpuller link generator GUI](https://jupyterhub.github.io/nbgitpuller/link) is used to create a
+[nbgitpuller link generator]: https://nbgitpuller.readthedocs.io/link
+
+1. The nbgitpuller link generator GUI is used to create a
    link.
 
    ![](https://raw.githubusercontent.com/jupyterhub/nbgitpuller/9f380a933335f0f069b6e2f9965ed78c3abcce7a/docs/_static/nbgitpuller-link-generator.png)