Skip to content

Commit

Permalink
generic rings: add docs and doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarbenjamin committed Sep 15, 2024
1 parent 4d4c4a3 commit 1a2f956
Show file tree
Hide file tree
Showing 6 changed files with 772 additions and 36 deletions.
15 changes: 3 additions & 12 deletions doc/source/_gr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ variables over the Gaussian integers :math:`\mathbb{Z}[i][x,y]` we would do::
>>> p
x^2 + 2*x*y + (2*I)*x + y^2 + (2*I)*y - 1

Some domains such as ``gr_fmpzi_ctx`` are global and do not need to be created.
Others such as ``gr_gr_mpoly_ctx`` are created using :meth:`gr_ctx.new`.

.. autoclass :: flint.types._gr.gr_ctx
:members:
:undoc-members:
Expand All @@ -42,18 +45,6 @@ variables over the Gaussian integers :math:`\mathbb{Z}[i][x,y]` we would do::
:members:
:undoc-members:
.. autoclass :: flint.types._gr.gr_matrix_domain_ctx
:members:
:undoc-members:
.. autoclass :: flint.types._gr.gr_matrix_space_ctx
:members:
:undoc-members:
.. autoclass :: flint.types._gr.gr_matrix_ring_ctx
:members:
:undoc-members:
.. autoclass :: flint.types._gr._gr_fmpz_ctx
:members:
:undoc-members:
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'furo'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,6 @@ Experimental generic rings interface
....................................

.. toctree::
:maxdepth: 1
:maxdepth: 2

_gr.rst
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ coverage
pytest-cov
sphinx
sphinx-rtd-theme
furo
12 changes: 6 additions & 6 deletions src/flint/types/_gr.pxd
Original file line number Diff line number Diff line change
Expand Up @@ -381,16 +381,16 @@ cdef class gr_mpoly_ctx(gr_ctx):
pass


cdef class gr_matrix_domain_ctx(gr_ctx):
pass
# cdef class gr_matrix_domain_ctx(gr_ctx):
# pass


cdef class gr_matrix_space_ctx(gr_ctx):
pass
# cdef class gr_matrix_space_ctx(gr_ctx):
# pass


cdef class gr_matrix_ring_ctx(gr_ctx):
pass
# cdef class gr_matrix_ring_ctx(gr_ctx):
# pass


@cython.no_gc
Expand Down
Loading

0 comments on commit 1a2f956

Please sign in to comment.