Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc URLs to point to readthedocs #202

Merged
merged 9 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 16 additions & 22 deletions .github/workflows/buildwheel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down Expand Up @@ -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'
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/

Expand Down Expand Up @@ -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
-------------------------------------
Expand Down
7 changes: 6 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "fredrik.johansson@gmail.com"},
]
Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion src/flint/types/fmpz_mod_poly.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion src/flint/types/fq_default_poly.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
Loading