Merge pull request #202 from oscarbenjamin/pr_update_doc_urls

Update doc URLs to point to readthedocs

Author: oscarbenjamin

.github/workflows/buildwheel.yml

@@ -80,28 +80,6 @@ jobs:
           name: sdist
           path: dist/*.tar.gz
 
-  test_rst:
-    needs: build_wheels
-    name: Test rst docs
-    runs-on: ubuntu-20.04
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - uses: actions/download-artifact@v4
-        with:
-          name: wheels-ubuntu-20.04
-          path: wheelhouse
-
-      - run: pip install --upgrade pip
-      - run: pip install pytest
-      - run: pip install --no-index --find-links wheelhouse python_flint
-      - run: pytest --doctest-glob='*.rst' doc/source
-
   test_wheels:
     needs: build_wheels
     name: Test ${{ matrix.python-version }} wheel on ${{ matrix.os }}
@@ -143,6 +121,22 @@ jobs:
       - run: pip install .
       - run: python -m flint.test --verbose
 
+  test_docs:
+    name: Test docs (build and doctest)
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: sudo apt-get update
+      - run: sudo apt-get install libflint-dev
+
+      - run: pip install --upgrade pip
+      - run: pip install -r requirements-dev.txt
+      - run: spin run -- pytest --doctest-glob='*.rst' doc/source
+      - run: spin docs
+
   # Test build with minimum Cython and meson-python versions.
   test_old_build_requires:
     name: 'Test old Cython/meson-python'

README.md

@@ -9,7 +9,7 @@ and Arb (arbitrary-precision ball arithmetic). Features:
 * Polynomials, power series and matrices over all the above types
 * Lots of mathematical functions
 
-Documentation: http://fredrikj.net/python-flint/
+Documentation: https://python-flint.readthedocs.io/en/latest/
 
 Repository: https://github.com/flintlib/python-flint/
 
@@ -67,7 +67,7 @@ as follows:
 See the documentation for further notes on building and installing
 python-flint:
 
-* https://fredrikj.net/python-flint/setup.html
+* https://python-flint.readthedocs.io/en/latest/setup.html
 
 Examples
 -------------------------------------

pyproject.toml

@@ -4,7 +4,6 @@ description = "Bindings for FLINT"
 version = "0.7.0a4"
 # This needs to be in sync with README, cibuildwheel and CI config.
 requires-python = ">= 3.10"
-urls = {Homepage = "https://github.com/flintlib/python-flint"}
 authors = [
     {name = "Fredrik Johansson", email = "[email protected]"},
 ]
@@ -13,6 +12,12 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Mathematics",
 ]
 
+[project.urls]
+Homepage = "https://github.com/flintlib/python-flint"
+Documentation = "https://python-flint.readthedocs.io/en/latest/"
+Repository = "https://github.com/flintlib/python-flint"
+Changelog = "https://github.com/flintlib/python-flint/blob/master/README.md#changelog"
+
 [project.readme]
 file = "README.md"
 content-type = "text/markdown"

src/flint/types/fmpz_mod_poly.pyx

@@ -1660,7 +1660,7 @@ cdef class fmpz_mod_poly(flint_poly):
         :math:`f^e \mod x^n`/
 
         Note: For exponents larger that 2^31 (which do not fit inside a ulong) use the
-        method :method:`~.pow_mod` with the explicit modulus `x^n`.
+        method :meth:`~.pow_mod` with the explicit modulus `x^n`.
 
             >>> R = fmpz_mod_poly_ctx(163)
             >>> x = R.gen()

src/flint/types/fq_default_poly.pyx

@@ -1139,7 +1139,7 @@ cdef class fq_default_poly(flint_poly):
         :math:`f^e \mod x^n`/
 
         Note: For exponents larger that 2^31 (which do not fit inside a ulong) use the
-        method :method:`~.pow_mod` with the explicit modulus `x^n`.
+        method :meth:`~.pow_mod` with the explicit modulus `x^n`.
 
             >>> R = fq_default_poly_ctx(163)
             >>> x = R.gen()