Skip to content

Commit 1a2f956

Browse files
committed
generic rings: add docs and doctests
1 parent 4d4c4a3 commit 1a2f956

File tree

6 files changed

+772
-36
lines changed

6 files changed

+772
-36
lines changed

doc/source/_gr.rst

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ variables over the Gaussian integers :math:`\mathbb{Z}[i][x,y]` we would do::
2626
>>> p
2727
x^2 + 2*x*y + (2*I)*x + y^2 + (2*I)*y - 1
2828

29+
Some domains such as ``gr_fmpzi_ctx`` are global and do not need to be created.
30+
Others such as ``gr_gr_mpoly_ctx`` are created using :meth:`gr_ctx.new`.
31+
2932
.. autoclass :: flint.types._gr.gr_ctx
3033
:members:
3134
:undoc-members:
@@ -42,18 +45,6 @@ variables over the Gaussian integers :math:`\mathbb{Z}[i][x,y]` we would do::
4245
:members:
4346
:undoc-members:
4447
45-
.. autoclass :: flint.types._gr.gr_matrix_domain_ctx
46-
:members:
47-
:undoc-members:
48-
49-
.. autoclass :: flint.types._gr.gr_matrix_space_ctx
50-
:members:
51-
:undoc-members:
52-
53-
.. autoclass :: flint.types._gr.gr_matrix_ring_ctx
54-
:members:
55-
:undoc-members:
56-
5748
.. autoclass :: flint.types._gr._gr_fmpz_ctx
5849
:members:
5950
:undoc-members:

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100

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

105105
# Theme options are theme-specific and customize the look and feel of a theme
106106
# further. For a list of options available for each theme, see the

doc/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,6 @@ Experimental generic rings interface
100100
....................................
101101

102102
.. toctree::
103-
:maxdepth: 1
103+
:maxdepth: 2
104104

105105
_gr.rst

requirements-dev.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ coverage
88
pytest-cov
99
sphinx
1010
sphinx-rtd-theme
11+
furo

src/flint/types/_gr.pxd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -381,16 +381,16 @@ cdef class gr_mpoly_ctx(gr_ctx):
381381
pass
382382

383383

384-
cdef class gr_matrix_domain_ctx(gr_ctx):
385-
pass
384+
# cdef class gr_matrix_domain_ctx(gr_ctx):
385+
# pass
386386

387387

388-
cdef class gr_matrix_space_ctx(gr_ctx):
389-
pass
388+
# cdef class gr_matrix_space_ctx(gr_ctx):
389+
# pass
390390

391391

392-
cdef class gr_matrix_ring_ctx(gr_ctx):
393-
pass
392+
# cdef class gr_matrix_ring_ctx(gr_ctx):
393+
# pass
394394

395395

396396
@cython.no_gc

0 commit comments

Comments
 (0)