Update the docs to point to readthedocs

.github/workflows/main.yml

@@ -58,62 +58,4 @@ jobs:
 
       - name: Run tests
         run: |
-          pytest
-
-  build-docs:
-    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pages: write
-      id-token: write
-
-    concurrency:
-      group: "pages"
-      cancel-in-progress: false
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.9'
-
-      - name: Install uv
-        run: |
-          pip install uv
-      
-      - name: Create virtual environment
-        run: |
-          uv venv
-      
-      - name: Install dependencies with uv
-        run: |
-          uv pip install ."[docs]"
-
-      - name: Build docs
-        run: |
-          uv run python -m sphinx -b html docs/source docs/build/html
-
-      - name: List files in docs/build/html
-        run: |
-          ls -la docs/build/html
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: 'docs/build/html'
-          name: github-pages
-
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          timeout: 600000
-          error_count: 10
-          reporting_interval: 5000
-          artifact_name: github-pages
-          preview: false
+          pytest

CITATION.cff

@@ -22,7 +22,7 @@ identifiers:
     value: 'https://github.com/cdtools-developers/cdtools'
     description: Github Repository
 repository-code: 'https://github.com/cdtools-developers/cdtools'
-url: 'https://cdtools-developers.github.io/cdtools/'
+url: 'https://cdtools.readthedocs.io'
 abstract: >-
   CDTools is a python library for ptychography and CDI
   reconstructions, using an Automatic Differentiation based

README.md

@@ -26,7 +26,7 @@ model.compare(dataset) # See how the simulated and measured patterns compare
 plt.show()
 ```
 
-Further documentation is found [here](https://cdtools-developers.github.io/cdtools/).
+Further documentation is found [here](https://cdtools.readthedocs.io).
 
 Instructions for building custom documentation based on a specific version or commit can be found [here](https://github.com/cdtools-developers/cdtools/blob/master/docs/build_custom_docs.md).
 

docs/build_custom_docs.md

@@ -4,7 +4,7 @@ This is a short description how to build custom documentation with `sphinx` base
 
 This requires a cloned version of `cdtools` from GitHub. See the installation guide for more information: 
 
-https://cdtools-developers.github.io/cdtools/installation.html#option-2-installation-from-source
+https://cdtools.readthedocs.io/en/stable/installation.html#option-2-installation-from-source
 
 
 ## Installation of Dependencies

docs/publish

@@ -1,34 +0,0 @@
-#!/usr/bin/env bash
-
-# switch branches and make sure we've got the latest version
-git checkout gh-pages
-git pull origin gh-pages
-
-# go to master for the latest docs from master
-git checkout master
-git pull origin master
-
-# build the docs
-make clean
-make html
-cd ..
-
-# switch back to gh-pages
-git checkout gh-pages
-
-# delete everything non-relevant and extract docs
-ls | grep -v docs | xargs rm -r 
-touch .nojekyll
-mv ./docs/build/html/* ./
-rm -rf ./docs
-
-# And commit to publish
-git add -A
-git commit -m "publishing updated docs..."
-git push origin gh-pages
-
-# switch back to master
-git checkout master
-
-# go back to docs dir
-cd docs

pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
 	"Operating System :: OS Independent",
 	"License :: OSI Approved :: MIT License"
 ]
-urls = { "Homepage" = "https://github.com/cdtools-developers/cdtools", "Documentation" = "https://cdtools-developers.github.io/cdtools/" }
+urls = { "Homepage" = "https://github.com/cdtools-developers/cdtools", "Documentation" = "https://cdtools.readthedocs.io" }
 dependencies = [
 	"numpy>=1.0",
 	"scipy>=1.0",