diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 817beef588..1226f61c73 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -29,7 +29,7 @@ jobs: - name: "Setup" run: | - sudo apt-get install -y python3-sphinx texlive-full + sudo apt-get install -y python3-sphinx texlive-full m4 sphinx-build --version - name: "Build documentation" diff --git a/.gitignore b/.gitignore index ce3195baac..4eff07daf8 100644 --- a/.gitignore +++ b/.gitignore @@ -30,6 +30,7 @@ doc/latex/flint-manual.* !doc/latex/flint-manual.tex doc/latex/input/* doc/latex/create_doc +doc/source/*.rst libflint* *.suo *.pyc diff --git a/doc/Makefile b/doc/Makefile index 27cc27e70a..2f0b400c6f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,15 +6,34 @@ SPHINXOPTS = -j=auto SPHINXBUILD = sphinx-build SPHINXPROJ = flint SOURCEDIR = source +ORIGSRCDIR = origsrc BUILDDIR = build +M4 := m4 + +SPHINX_ACTIONS := html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf latexpdfja text man texinfo info gettext changes xml pseudoxml linkcheck doctest coverage + +CONFIG := macros.m4 +SRCS := $(wildcard $(ORIGSRCDIR)/*.rst) +OBJS := $(patsubst $(ORIGSRCDIR)/%,$(SOURCEDIR)/%,$(SRCS)) + # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: help Makefile +$(SOURCEDIR)/%.rst: $(ORIGSRCDIR)/%.rst $(CONFIG) + @$(M4) $< > $@ + +preprocess: $(OBJS) -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile +$(SPHINX_ACTIONS): Makefile preprocess @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +clean: + rm -f $(OBJS) + rm -rf $(BUILDDIR) + +print-%: + @echo "$*=$($*)" + +.PHONY: help Makefile preprocess diff --git a/doc/macros.m4 b/doc/macros.m4 new file mode 100644 index 0000000000..b3748ffbf0 --- /dev/null +++ b/doc/macros.m4 @@ -0,0 +1,148 @@ +dnl############################################################################ +dnl Change quotation marks to avoid conflicts +dnl############################################################################ +changequote({{{,}}})dnl +dnl############################################################################ +dnl notation +dnl############################################################################ +define({{{_neg_}}},dnl +{{{-$1}}})dnl +define({{{_add_}}},dnl +{{{$1 + $2}}})dnl +define({{{_sub_}}},dnl +{{{$1 - $2}}})dnl +define({{{_mul_}}},dnl +{{{$1 \cdot $2}}})dnl +define({{{_div_}}},dnl +{{{$1 / $2}}})dnl +define({{{_pow_}}},dnl +{{{{$1}^{$2}}}})dnl +define({{{_addmul_}}},dnl +{{{_add_($1, _mul_($2, $3))}}})dnl +define({{{_submul_}}},dnl +{{{_sub_($1, _mul_($2, $3))}}})dnl +define({{{_fmma_}}},dnl +{{{_add_(_mul_($1, $2), _mul_($3, $4))}}})dnl +define({{{_fmms_}}},dnl +{{{_sub_(_mul_($1, $2), _mul_($3, $4))}}})dnl +define({{{_lt_}}},dnl +{{{$1 < $2}}})dnl +define({{{_gt_}}},dnl +{{{$1 > $2}}})dnl +define({{{_eq_}}},dnl +{{{$1 = $2}}})dnl +dnl +define({{{_boolzero_}}},dnl +{{{`0`}}})dnl +define({{{_boolpos_}}},dnl +{{{`1`}}})dnl +define({{{_boolneg}}},dnl +{{{`-1`}}})dnl +define({{{_zero_}}},dnl +{{{`0`}}})dnl +define({{{_one_}}},dnl +{{{`1`}}})dnl +dnl############################################################################ +dnl memory management +dnl############################################################################ +define({{{desc_init_set}}},{{{ + Initialises `$1` and sets it to `$2`.dnl +}}})dnl +dnl############################################################################ +dnl set +dnl############################################################################ +define({{{desc_set}}},{{{ + Sets `$1` to `$2`.dnl +}}})dnl +define({{{desc_zero}}},{{{ + Sets `$1` to _zero_.dnl +}}})dnl +define({{{desc_one}}},{{{ + Sets `$1` to _one_.dnl +}}})dnl +dnl############################################################################ +dnl negation, absolute value etc. +dnl############################################################################ +define({{{desc_neg}}},{{{ + Sets `$1` to `_neg_($2)`.dnl +}}})dnl +define({{{desc_abs}}},{{{ + Sets `$1` to the absolute value of `$2`.dnl +}}})dnl +dnl############################################################################ +dnl basic arithmetic operations +dnl############################################################################ +define({{{desc_add}}},{{{ + Sets `$1` to `_add_($2, $3)`.dnl +}}})dnl +define({{{desc_sub}}},{{{ + Sets `$1` to `_sub_($2, $3)`.dnl +}}})dnl +define({{{desc_mul}}},{{{ + Sets `$1` to `_mul_($2, $3)`.dnl +}}})dnl +define({{{desc_divexact}}},{{{ + Sets `$1` to `_div_($2, $3)` under the assumption that the division is + exact. If `$3` is _zero_, an exception is raised.dnl +}}})dnl +dnl############################################################################ +dnl extended basic arithmetic operations +dnl############################################################################ +define({{{desc_addmul}}},{{{ + Sets `$1` to `_addmul_($1, $2, $3)`.dnl +}}})dnl +define({{{desc_submul}}},{{{ + Sets `$1` to `_submul_($1, $2, $3)`.dnl +}}})dnl +define({{{desc_fmma}}},{{{ + Sets `$1` to `_fmma_($2, $3, $4, $5)`.dnl +}}})dnl +define({{{desc_fmms}}},{{{ + Sets `$1` to `_fmms_($2, $3, $4, $5)`.dnl +}}})dnl +dnl############################################################################ +dnl powering +dnl############################################################################ +define({{{desc_pow}}},{{{ + Sets `$1` to `_pow_($2, $3)`. Defines `_eq_(_pow_(0, 0), 1)`.dnl +}}})dnl +dnl############################################################################ +dnl comparisons +dnl############################################################################ +define({{{desc_cmp}}},{{{ + Returns _boolneg_ if `_lt_($1, $2)`, _boolpos_ if `_gt_($1, $2)`, otherwise + returns zero.dnl +}}})dnl +define({{{desc_equal}}},{{{ + Returns _boolpos_ if `_eq_($1, $2)`, otherwise returns _boolzero_.dnl +}}})dnl +define({{{desc_is_zero}}},{{{ + Returns _boolpos_ if `_eq_($1, 0)`, otherwise returns _boolzero_.dnl +}}})dnl +define({{{desc_is_one}}},{{{ + Returns _boolpos_ if `_eq_($1, 1)`, otherwise returns _boolzero_.dnl +}}})dnl +define({{{desc_sgn}}},{{{ + Returns the sign of `$1`. That is, returns `-1` if `_lt_($1, 0)`, `1` if + `_gt_($1, 0)` and `0` if `_eq_($1, 0)`.dnl +}}})dnl +dnl############################################################################ +dnl factoring +dnl############################################################################ +define({{{desc_sqrt_nonordered_ring}}},{{{ + If `$2` is a perfect square, sets `$1` to a square root of `$2` + and returns _boolpos_. Otherwise returns _boolzero_.dnl +}}})dnl +define({{{desc_gcd_int}}},{{{ + Sets `$1` to the greatest common divisor of `$2` and `$3`. The result is + always non-negative.dnl +}}})dnl +define({{{desc_divisible}}},{{{ + Returns _boolpos_ if there is an `x` such that `_eq_($1, _mul_(x, $2))`, + and returns _boolzero_ if there is none.dnl +}}})dnl +define({{{desc_divides}}},{{{ + Returns _boolpos_ if there is an `x` such that `_eq_($2, _mul_(x, $3))` and + sets `_eq_($1, x)`, and returns _boolzero_ if there is none and sets + `_eq_($1, 0)`.dnl +}}})dnl diff --git a/doc/source/acb.rst b/doc/origsrc/acb.rst similarity index 99% rename from doc/source/acb.rst rename to doc/origsrc/acb.rst index a4d0f54136..d0e29cb178 100644 --- a/doc/source/acb.rst +++ b/doc/origsrc/acb.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb: **acb.h** -- complex numbers diff --git a/doc/source/acb_calc.rst b/doc/origsrc/acb_calc.rst similarity index 99% rename from doc/source/acb_calc.rst rename to doc/origsrc/acb_calc.rst index de67707534..1bc21a1fdc 100644 --- a/doc/source/acb_calc.rst +++ b/doc/origsrc/acb_calc.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-calc: **acb_calc.h** -- calculus with complex-valued functions diff --git a/doc/source/acb_dft.rst b/doc/origsrc/acb_dft.rst similarity index 99% rename from doc/source/acb_dft.rst rename to doc/origsrc/acb_dft.rst index b4d8ff9fb5..2e683963b6 100644 --- a/doc/source/acb_dft.rst +++ b/doc/origsrc/acb_dft.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-dft: **acb_dft.h** -- Discrete Fourier transform diff --git a/doc/source/acb_dirichlet.rst b/doc/origsrc/acb_dirichlet.rst similarity index 99% rename from doc/source/acb_dirichlet.rst rename to doc/origsrc/acb_dirichlet.rst index 44b812543e..33200505b7 100644 --- a/doc/source/acb_dirichlet.rst +++ b/doc/origsrc/acb_dirichlet.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-dirichlet: **acb_dirichlet.h** -- Dirichlet L-functions, Riemann zeta and related functions diff --git a/doc/source/acb_elliptic.rst b/doc/origsrc/acb_elliptic.rst similarity index 99% rename from doc/source/acb_elliptic.rst rename to doc/origsrc/acb_elliptic.rst index d74ecafba3..237b4239d7 100644 --- a/doc/source/acb_elliptic.rst +++ b/doc/origsrc/acb_elliptic.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-elliptic: **acb_elliptic.h** -- elliptic integrals and functions of complex variables diff --git a/doc/source/acb_hypgeom.rst b/doc/origsrc/acb_hypgeom.rst similarity index 99% rename from doc/source/acb_hypgeom.rst rename to doc/origsrc/acb_hypgeom.rst index 13299b7114..f1775f6a75 100644 --- a/doc/source/acb_hypgeom.rst +++ b/doc/origsrc/acb_hypgeom.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-hypgeom: **acb_hypgeom.h** -- hypergeometric functions of complex variables diff --git a/doc/source/acb_mat.rst b/doc/origsrc/acb_mat.rst similarity index 99% rename from doc/source/acb_mat.rst rename to doc/origsrc/acb_mat.rst index b3b5eddb8f..9a10beb2fb 100644 --- a/doc/source/acb_mat.rst +++ b/doc/origsrc/acb_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-mat: **acb_mat.h** -- matrices over the complex numbers diff --git a/doc/source/acb_modular.rst b/doc/origsrc/acb_modular.rst similarity index 99% rename from doc/source/acb_modular.rst rename to doc/origsrc/acb_modular.rst index ca05f2dd17..898885a2e3 100644 --- a/doc/source/acb_modular.rst +++ b/doc/origsrc/acb_modular.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-modular: **acb_modular.h** -- modular forms of complex variables diff --git a/doc/source/acb_poly.rst b/doc/origsrc/acb_poly.rst similarity index 99% rename from doc/source/acb_poly.rst rename to doc/origsrc/acb_poly.rst index 66148a38a0..ae0f8d9c7f 100644 --- a/doc/source/acb_poly.rst +++ b/doc/origsrc/acb_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-poly: **acb_poly.h** -- polynomials over the complex numbers diff --git a/doc/source/acb_theta.rst b/doc/origsrc/acb_theta.rst similarity index 99% rename from doc/source/acb_theta.rst rename to doc/origsrc/acb_theta.rst index 1f4700352e..d08320ab21 100644 --- a/doc/source/acb_theta.rst +++ b/doc/origsrc/acb_theta.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acb-theta: **acb_theta.h** -- Riemann theta functions diff --git a/doc/source/acf.rst b/doc/origsrc/acf.rst similarity index 99% rename from doc/source/acf.rst rename to doc/origsrc/acf.rst index 0d06433a49..3cf542cc2f 100644 --- a/doc/source/acf.rst +++ b/doc/origsrc/acf.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _acf: **acf.h** -- complex floating-point numbers diff --git a/doc/source/agm.rst b/doc/origsrc/agm.rst similarity index 99% rename from doc/source/agm.rst rename to doc/origsrc/agm.rst index fc846267d9..4096224fcc 100644 --- a/doc/source/agm.rst +++ b/doc/origsrc/agm.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _algorithms_agm: Algorithms for the arithmetic-geometric mean diff --git a/doc/source/aprcl.rst b/doc/origsrc/aprcl.rst similarity index 99% rename from doc/source/aprcl.rst rename to doc/origsrc/aprcl.rst index 1d593f0ba7..dbb4d85d46 100644 --- a/doc/source/aprcl.rst +++ b/doc/origsrc/aprcl.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _aprcl: **aprcl.h** -- APRCL primality testing diff --git a/doc/source/arb.rst b/doc/origsrc/arb.rst similarity index 99% rename from doc/source/arb.rst rename to doc/origsrc/arb.rst index 0dd829f8d9..d24d0a4f15 100644 --- a/doc/source/arb.rst +++ b/doc/origsrc/arb.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arb: **arb.h** -- real numbers diff --git a/doc/source/arb_calc.rst b/doc/origsrc/arb_calc.rst similarity index 99% rename from doc/source/arb_calc.rst rename to doc/origsrc/arb_calc.rst index 33b45abf37..cbd8a9c837 100644 --- a/doc/source/arb_calc.rst +++ b/doc/origsrc/arb_calc.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arb-calc: **arb_calc.h** -- calculus with real-valued functions diff --git a/doc/source/arb_fmpz_poly.rst b/doc/origsrc/arb_fmpz_poly.rst similarity index 99% rename from doc/source/arb_fmpz_poly.rst rename to doc/origsrc/arb_fmpz_poly.rst index baebf8521e..4db0914e44 100644 --- a/doc/source/arb_fmpz_poly.rst +++ b/doc/origsrc/arb_fmpz_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arb_fmpz_poly: **arb_fmpz_poly.h** -- extra methods for integer polynomials diff --git a/doc/source/arb_fpwrap.rst b/doc/origsrc/arb_fpwrap.rst similarity index 99% rename from doc/source/arb_fpwrap.rst rename to doc/origsrc/arb_fpwrap.rst index ac494a79e1..2c37f52d6f 100644 --- a/doc/source/arb_fpwrap.rst +++ b/doc/origsrc/arb_fpwrap.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arb_fpwrap: **arb_fpwrap.h** -- floating-point wrappers of Arb mathematical functions diff --git a/doc/source/arb_hypgeom.rst b/doc/origsrc/arb_hypgeom.rst similarity index 99% rename from doc/source/arb_hypgeom.rst rename to doc/origsrc/arb_hypgeom.rst index c31fdaed56..59f2d5966c 100644 --- a/doc/source/arb_hypgeom.rst +++ b/doc/origsrc/arb_hypgeom.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arb-hypgeom: **arb_hypgeom.h** -- hypergeometric functions of real variables diff --git a/doc/source/arb_mat.rst b/doc/origsrc/arb_mat.rst similarity index 99% rename from doc/source/arb_mat.rst rename to doc/origsrc/arb_mat.rst index 3c56495354..ea775a6284 100644 --- a/doc/source/arb_mat.rst +++ b/doc/origsrc/arb_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arb-mat: **arb_mat.h** -- matrices over the real numbers diff --git a/doc/source/arb_poly.rst b/doc/origsrc/arb_poly.rst similarity index 99% rename from doc/source/arb_poly.rst rename to doc/origsrc/arb_poly.rst index 14d330b2bd..5e30631c12 100644 --- a/doc/source/arb_poly.rst +++ b/doc/origsrc/arb_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arb-poly: **arb_poly.h** -- polynomials over the real numbers diff --git a/doc/source/arf.rst b/doc/origsrc/arf.rst similarity index 99% rename from doc/source/arf.rst rename to doc/origsrc/arf.rst index e35b3d23d2..ccee5e8bf5 100644 --- a/doc/source/arf.rst +++ b/doc/origsrc/arf.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arf: **arf.h** -- arbitrary-precision floating-point numbers diff --git a/doc/source/arith.rst b/doc/origsrc/arith.rst similarity index 99% rename from doc/source/arith.rst rename to doc/origsrc/arith.rst index e311f69ecc..db7d7991c1 100644 --- a/doc/source/arith.rst +++ b/doc/origsrc/arith.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _arith: **arith.h** -- arithmetic and special functions diff --git a/doc/source/bernoulli.rst b/doc/origsrc/bernoulli.rst similarity index 99% rename from doc/source/bernoulli.rst rename to doc/origsrc/bernoulli.rst index 7cc7deee24..59b7e5d272 100644 --- a/doc/source/bernoulli.rst +++ b/doc/origsrc/bernoulli.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _bernoulli: **bernoulli.h** -- support for Bernoulli numbers diff --git a/doc/source/bool_mat.rst b/doc/origsrc/bool_mat.rst similarity index 99% rename from doc/source/bool_mat.rst rename to doc/origsrc/bool_mat.rst index c97ee95b81..78c2a21abf 100644 --- a/doc/source/bool_mat.rst +++ b/doc/origsrc/bool_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _bool-mat: **bool_mat.h** -- matrices over booleans diff --git a/doc/source/bug_reporting.rst b/doc/origsrc/bug_reporting.rst similarity index 97% rename from doc/source/bug_reporting.rst rename to doc/origsrc/bug_reporting.rst index 4a15f37d7c..337fac8b66 100644 --- a/doc/source/bug_reporting.rst +++ b/doc/origsrc/bug_reporting.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _bug_reporting: **Bug reporting** diff --git a/doc/source/building.rst b/doc/origsrc/building.rst similarity index 99% rename from doc/source/building.rst rename to doc/origsrc/building.rst index 37fbcd01a9..b63b1e307a 100644 --- a/doc/source/building.rst +++ b/doc/origsrc/building.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _building: **Building, testing and installing** diff --git a/doc/source/ca.rst b/doc/origsrc/ca.rst similarity index 99% rename from doc/source/ca.rst rename to doc/origsrc/ca.rst index 891b511b4a..aeeb4a9754 100644 --- a/doc/source/ca.rst +++ b/doc/origsrc/ca.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _ca: **ca.h** -- exact real and complex numbers diff --git a/doc/source/ca_ext.rst b/doc/origsrc/ca_ext.rst similarity index 99% rename from doc/source/ca_ext.rst rename to doc/origsrc/ca_ext.rst index a39390ab16..353668907d 100644 --- a/doc/source/ca_ext.rst +++ b/doc/origsrc/ca_ext.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _ca-ext: **ca_ext.h** -- real and complex extension numbers diff --git a/doc/source/ca_field.rst b/doc/origsrc/ca_field.rst similarity index 99% rename from doc/source/ca_field.rst rename to doc/origsrc/ca_field.rst index 37a4792a02..bd8e0e5c53 100644 --- a/doc/source/ca_field.rst +++ b/doc/origsrc/ca_field.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _ca-field: **ca_field.h** -- extension fields diff --git a/doc/source/ca_mat.rst b/doc/origsrc/ca_mat.rst similarity index 99% rename from doc/source/ca_mat.rst rename to doc/origsrc/ca_mat.rst index 4d38fef58a..1161f2fa8c 100644 --- a/doc/source/ca_mat.rst +++ b/doc/origsrc/ca_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _ca-mat: **ca_mat.h** -- matrices over the real and complex numbers diff --git a/doc/source/ca_poly.rst b/doc/origsrc/ca_poly.rst similarity index 99% rename from doc/source/ca_poly.rst rename to doc/origsrc/ca_poly.rst index 982bba34ff..a6a3022cba 100644 --- a/doc/source/ca_poly.rst +++ b/doc/origsrc/ca_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _ca-poly: **ca_poly.h** -- dense univariate polynomials over the real and complex numbers diff --git a/doc/source/ca_vec.rst b/doc/origsrc/ca_vec.rst similarity index 99% rename from doc/source/ca_vec.rst rename to doc/origsrc/ca_vec.rst index ac4ce9960c..f8fc6df8c2 100644 --- a/doc/source/ca_vec.rst +++ b/doc/origsrc/ca_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _ca-vec: **ca_vec.h** -- vectors of real and complex numbers diff --git a/doc/source/calcium.rst b/doc/origsrc/calcium.rst similarity index 99% rename from doc/source/calcium.rst rename to doc/origsrc/calcium.rst index cc4bbbe542..6b480f3086 100644 --- a/doc/source/calcium.rst +++ b/doc/origsrc/calcium.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _calcium: **calcium.h** -- global definitions diff --git a/doc/source/constants.rst b/doc/origsrc/constants.rst similarity index 99% rename from doc/source/constants.rst rename to doc/origsrc/constants.rst index 11b1392cce..09e17e4aae 100644 --- a/doc/source/constants.rst +++ b/doc/origsrc/constants.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _algorithms_constants: Algorithms for mathematical constants diff --git a/doc/source/contributing.rst b/doc/origsrc/contributing.rst similarity index 99% rename from doc/source/contributing.rst rename to doc/origsrc/contributing.rst index 464a70f920..404ae4198b 100644 --- a/doc/source/contributing.rst +++ b/doc/origsrc/contributing.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _contributing: **Contributing to FLINT** diff --git a/doc/source/contributors.rst b/doc/origsrc/contributors.rst similarity index 96% rename from doc/source/contributors.rst rename to doc/origsrc/contributors.rst index 11af33c890..f0bf610471 100644 --- a/doc/source/contributors.rst +++ b/doc/origsrc/contributors.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _contributors: **Contributors** diff --git a/doc/source/d_mat.rst b/doc/origsrc/d_mat.rst similarity index 99% rename from doc/source/d_mat.rst rename to doc/origsrc/d_mat.rst index 76aa25c756..0abff86631 100644 --- a/doc/source/d_mat.rst +++ b/doc/origsrc/d_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _d-mat: **d_mat.h** -- double precision matrices diff --git a/doc/source/d_vec.rst b/doc/origsrc/d_vec.rst similarity index 99% rename from doc/source/d_vec.rst rename to doc/origsrc/d_vec.rst index cad3446898..0b757356e7 100644 --- a/doc/source/d_vec.rst +++ b/doc/origsrc/d_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _d-vec: **d_vec.h** -- double precision vectors diff --git a/doc/source/dirichlet.rst b/doc/origsrc/dirichlet.rst similarity index 99% rename from doc/source/dirichlet.rst rename to doc/origsrc/dirichlet.rst index 15e564614b..3bd74afad2 100644 --- a/doc/source/dirichlet.rst +++ b/doc/origsrc/dirichlet.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _dirichlet: **dirichlet.h** -- Dirichlet characters diff --git a/doc/source/dlog.rst b/doc/origsrc/dlog.rst similarity index 99% rename from doc/source/dlog.rst rename to doc/origsrc/dlog.rst index 2ca95eb451..7d10bdec16 100644 --- a/doc/source/dlog.rst +++ b/doc/origsrc/dlog.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _dlog: **dlog.h** -- discrete logarithms mod ulong primes diff --git a/doc/source/double_extras.rst b/doc/origsrc/double_extras.rst similarity index 99% rename from doc/source/double_extras.rst rename to doc/origsrc/double_extras.rst index 725892e011..ff9a31a55b 100644 --- a/doc/source/double_extras.rst +++ b/doc/origsrc/double_extras.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _double-extras: **double_extras.h** -- support functions for double arithmetic diff --git a/doc/source/double_interval.rst b/doc/origsrc/double_interval.rst similarity index 99% rename from doc/source/double_interval.rst rename to doc/origsrc/double_interval.rst index c53e5724fd..4a9774e752 100644 --- a/doc/source/double_interval.rst +++ b/doc/origsrc/double_interval.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _double_interval: **double_interval.h** -- double-precision interval arithmetic and helpers diff --git a/doc/source/examples.rst b/doc/origsrc/examples.rst similarity index 98% rename from doc/source/examples.rst rename to doc/origsrc/examples.rst index dc76d5237b..42f0da8f28 100644 --- a/doc/source/examples.rst +++ b/doc/origsrc/examples.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _examples: **Examples** diff --git a/doc/source/examples_arb.rst b/doc/origsrc/examples_arb.rst similarity index 99% rename from doc/source/examples_arb.rst rename to doc/origsrc/examples_arb.rst index 0a9901c6aa..727513f3f1 100644 --- a/doc/source/examples_arb.rst +++ b/doc/origsrc/examples_arb.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _examples-arb: Arb example programs diff --git a/doc/source/examples_calcium.rst b/doc/origsrc/examples_calcium.rst similarity index 99% rename from doc/source/examples_calcium.rst rename to doc/origsrc/examples_calcium.rst index 5a36132844..e5c0ea85b3 100644 --- a/doc/source/examples_calcium.rst +++ b/doc/origsrc/examples_calcium.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _examples-calcium: Calcium example programs diff --git a/doc/source/fexpr.rst b/doc/origsrc/fexpr.rst similarity index 99% rename from doc/source/fexpr.rst rename to doc/origsrc/fexpr.rst index 8633d53f5d..16eedddcc7 100644 --- a/doc/source/fexpr.rst +++ b/doc/origsrc/fexpr.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fexpr: **fexpr.h** -- flat-packed symbolic expressions diff --git a/doc/source/fexpr_builtin.rst b/doc/origsrc/fexpr_builtin.rst similarity index 99% rename from doc/source/fexpr_builtin.rst rename to doc/origsrc/fexpr_builtin.rst index 38c7900ca3..3275c06f38 100644 --- a/doc/source/fexpr_builtin.rst +++ b/doc/origsrc/fexpr_builtin.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fexpr-builtin: **fexpr_builtin.h** -- builtin symbols diff --git a/doc/source/fft.rst b/doc/origsrc/fft.rst similarity index 99% rename from doc/source/fft.rst rename to doc/origsrc/fft.rst index fcda6a9ba9..ea67f6c731 100644 --- a/doc/source/fft.rst +++ b/doc/origsrc/fft.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fft: **fft.h** -- Schoenhage-Strassen FFT diff --git a/doc/source/fft_small.rst b/doc/origsrc/fft_small.rst similarity index 99% rename from doc/source/fft_small.rst rename to doc/origsrc/fft_small.rst index 2bfda79400..edf4f208db 100644 --- a/doc/source/fft_small.rst +++ b/doc/origsrc/fft_small.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fft-small: **fft_small.h** -- FFT modulo word-size primes diff --git a/doc/source/flint.rst b/doc/origsrc/flint.rst similarity index 99% rename from doc/source/flint.rst rename to doc/origsrc/flint.rst index f8790d1482..e9f9468260 100644 --- a/doc/source/flint.rst +++ b/doc/origsrc/flint.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _flint: **flint.h** -- global definitions diff --git a/doc/source/fmpq.rst b/doc/origsrc/fmpq.rst similarity index 99% rename from doc/source/fmpq.rst rename to doc/origsrc/fmpq.rst index 7e6e28bf69..667a3b760d 100644 --- a/doc/source/fmpq.rst +++ b/doc/origsrc/fmpq.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpq: **fmpq.h** -- rational numbers diff --git a/doc/source/fmpq_mat.rst b/doc/origsrc/fmpq_mat.rst similarity index 99% rename from doc/source/fmpq_mat.rst rename to doc/origsrc/fmpq_mat.rst index 0db4365fd7..93aa3c3376 100644 --- a/doc/source/fmpq_mat.rst +++ b/doc/origsrc/fmpq_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpq-mat: **fmpq_mat.h** -- matrices over the rational numbers diff --git a/doc/source/fmpq_mpoly.rst b/doc/origsrc/fmpq_mpoly.rst similarity index 99% rename from doc/source/fmpq_mpoly.rst rename to doc/origsrc/fmpq_mpoly.rst index dd6fa7d4de..ba81b9f494 100644 --- a/doc/source/fmpq_mpoly.rst +++ b/doc/origsrc/fmpq_mpoly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpq-mpoly: **fmpq_mpoly.h** -- multivariate polynomials over the rational numbers diff --git a/doc/source/fmpq_mpoly_factor.rst b/doc/origsrc/fmpq_mpoly_factor.rst similarity index 99% rename from doc/source/fmpq_mpoly_factor.rst rename to doc/origsrc/fmpq_mpoly_factor.rst index 5812a4daaa..721bb4784d 100644 --- a/doc/source/fmpq_mpoly_factor.rst +++ b/doc/origsrc/fmpq_mpoly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpq-mpoly-factor: **fmpq_mpoly_factor.h** -- factorisation of multivariate polynomials over the rational numbers diff --git a/doc/source/fmpq_poly.rst b/doc/origsrc/fmpq_poly.rst similarity index 99% rename from doc/source/fmpq_poly.rst rename to doc/origsrc/fmpq_poly.rst index b678b6fbbf..36b7d8934d 100644 --- a/doc/source/fmpq_poly.rst +++ b/doc/origsrc/fmpq_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpq-poly: **fmpq_poly.h** -- univariate polynomials over the rational numbers diff --git a/doc/source/fmpq_vec.rst b/doc/origsrc/fmpq_vec.rst similarity index 99% rename from doc/source/fmpq_vec.rst rename to doc/origsrc/fmpq_vec.rst index d177c86803..8230d16014 100644 --- a/doc/source/fmpq_vec.rst +++ b/doc/origsrc/fmpq_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpq-vec: **fmpq_vec.h** -- vectors over rational numbers diff --git a/doc/source/fmpz.rst b/doc/origsrc/fmpz.rst similarity index 95% rename from doc/source/fmpz.rst rename to doc/origsrc/fmpz.rst index 4f71a9da28..624e6b5716 100644 --- a/doc/source/fmpz.rst +++ b/doc/origsrc/fmpz.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz: **fmpz.h** -- integers @@ -229,12 +230,9 @@ Memory management whether the reentrant or non-reentrant version of FLINT is built. .. function:: void fmpz_init_set(fmpz_t f, const fmpz_t g) - -.. function:: void fmpz_init_set_ui(fmpz_t f, ulong g) - -.. function:: void fmpz_init_set_si(fmpz_t f, slong g) - - Initialises `f` and sets it to the value of `g`. + void fmpz_init_set_ui(fmpz_t f, ulong g) + void fmpz_init_set_si(fmpz_t f, slong g) +desc_init_set(f, g) Random generation @@ -323,14 +321,6 @@ Conversion `f` cannot be represented exactly. The outcome is undefined if `f` is too large to fit in the normal range of a double. -.. function:: void fmpz_set_mpf(fmpz_t f, const mpf_t x) - - Sets `f` to the ``mpf_t`` `x`, rounding down towards zero if - the value of `x` is fractional. - - **Note:** Requires that ``gmp.h`` has been included before any FLINT - header is included. - .. function:: void fmpz_get_mpf(mpf_t x, const fmpz_t f) Sets the value of the ``mpf_t`` `x` to the value of `f`. @@ -374,20 +364,6 @@ Conversion the function. Otherwise, it is up to the caller to ensure that the allocated block of memory is sufficiently large. -.. function:: void fmpz_set_si(fmpz_t f, slong val) - - Sets `f` to the given ``slong`` value. - -.. function:: void fmpz_set_ui(fmpz_t f, ulong val) - - Sets `f` to the given ``ulong`` value. - -.. function:: void fmpz_set_d(fmpz_t f, double c) - - Sets `f` to the ``double`` `c`, rounding down towards zero if - the value of `c` is fractional. The outcome is undefined if `c` is - infinite, not-a-number, or subnormal. - .. function:: void fmpz_set_d_2exp(fmpz_t f, double d, slong exp) Sets `f` to the nearest integer to `d 2^{exp}`. @@ -458,13 +434,6 @@ Conversion Retrieves the value of `in` modulo `2^{2 * FLINT\_BITS}` and puts the high and low words into ``*hi`` and ``*lo`` respectively. -.. function:: void fmpz_set_mpz(fmpz_t f, const mpz_t x) - - Sets `f` to the given ``mpz_t`` value. - - **Note:** Requires that ``gmp.h`` has been included before any FLINT - header is included. - .. function:: int fmpz_set_str(fmpz_t f, const char * str, int b) Sets `f` to the value given in the null-terminated string ``str``, @@ -644,9 +613,7 @@ Basic properties and manipulation value of `f`. If `f` is zero then `0` is returned. .. function:: int fmpz_sgn(const fmpz_t f) - - Returns `-1` if the sign of `f` is negative, `+1` if it is positive, - otherwise returns `0`. +desc_sgn(f) .. function:: flint_bitcnt_t fmpz_val2(const fmpz_t f) @@ -659,16 +626,25 @@ Basic properties and manipulation Efficiently swaps `f` and `g`. No data is copied. .. function:: void fmpz_set(fmpz_t f, const fmpz_t g) + void fmpz_set_ui(fmpz_t f, ulong g) + void fmpz_set_si(fmpz_t f, slong g) + void fmpz_set_mpz(fmpz_t f, const mpz_t g) + void fmpz_set_d(fmpz_t f, double g) + void fmpz_set_mpf(fmpz_t f, const mpf_t g) +desc_set(f, g) - Sets `f` to the same value as `g`. + For floating-points, the outcome is undefined if `g` is infinite, NaN or + subnormal. Moreover, if `g` is fractional, the value is rounded down + towards zero. -.. function:: void fmpz_zero(fmpz_t f) + **Note:** ``fmpz_set_mpz`` and ``fmpz_set_mpf`` requires that ``gmp.h`` has + been included before any FLINT header is included. - Sets `f` to zero. +.. function:: void fmpz_zero(fmpz_t f) +desc_zero(f) .. function:: void fmpz_one(fmpz_t f) - - Sets `f` to one. +desc_one(f) .. function:: int fmpz_abs_fits_ui(const fmpz_t f) @@ -709,13 +685,9 @@ Comparison .. function:: int fmpz_cmp(const fmpz_t f, const fmpz_t g) - -.. function:: int fmpz_cmp_ui(const fmpz_t f, ulong g) - -.. function:: int fmpz_cmp_si(const fmpz_t f, slong g) - - Returns a negative value if `f < g`, positive value if `g < f`, - otherwise returns `0`. + int fmpz_cmp_ui(const fmpz_t f, ulong g) + int fmpz_cmp_si(const fmpz_t f, slong g) +desc_cmp(f, g) .. function:: int fmpz_cmpabs(const fmpz_t f, const fmpz_t g) @@ -728,20 +700,15 @@ Comparison `\lvert 2g\rvert < \lvert f \rvert`, otherwise returns `0`. .. function:: int fmpz_equal(const fmpz_t f, const fmpz_t g) - -.. function:: int fmpz_equal_ui(const fmpz_t f, ulong g) - -.. function:: int fmpz_equal_si(const fmpz_t f, slong g) - - Returns `1` if `f` is equal to `g`, otherwise returns `0`. + int fmpz_equal_ui(const fmpz_t f, ulong g) + int fmpz_equal_si(const fmpz_t f, slong g) +desc_equal(f, g) .. function:: int fmpz_is_zero(const fmpz_t f) - - Returns `1` if `f` is `0`, otherwise returns `0`. +desc_is_zero(f) .. function:: int fmpz_is_one(const fmpz_t f) - - Returns `1` if `f` is equal to one, otherwise returns `0`. +desc_is_one(f) .. function:: int fmpz_is_pm1(const fmpz_t f) @@ -760,31 +727,36 @@ Basic arithmetic -------------------------------------------------------------------------------- -.. function:: void fmpz_neg(fmpz_t f1, const fmpz_t f2) +.. function:: void fmpz_neg(fmpz_t f, const fmpz_t g) +desc_neg(f, g) - Sets `f_1` to `-f_2`. - -.. function:: void fmpz_abs(fmpz_t f1, const fmpz_t f2) - - Sets `f_1` to the absolute value of `f_2`. +.. function:: void fmpz_abs(fmpz_t f, const fmpz_t g) +desc_abs(f, g) .. function:: void fmpz_add(fmpz_t f, const fmpz_t g, const fmpz_t h) void fmpz_add_ui(fmpz_t f, const fmpz_t g, ulong h) void fmpz_add_si(fmpz_t f, const fmpz_t g, slong h) - - Sets `f` to `g + h`. +desc_add(f, g, h) .. function:: void fmpz_sub(fmpz_t f, const fmpz_t g, const fmpz_t h) void fmpz_sub_ui(fmpz_t f, const fmpz_t g, ulong h) void fmpz_sub_si(fmpz_t f, const fmpz_t g, slong h) - - Sets `f` to `g - h`. +desc_sub(f, g, h) .. function:: void fmpz_mul(fmpz_t f, const fmpz_t g, const fmpz_t h) void fmpz_mul_ui(fmpz_t f, const fmpz_t g, ulong h) void fmpz_mul_si(fmpz_t f, const fmpz_t g, slong h) +desc_mul(f, g, h) - Sets `f` to `g \times h`. +.. function:: void fmpz_addmul(fmpz_t f, const fmpz_t g, const fmpz_t h) + void fmpz_addmul_ui(fmpz_t f, const fmpz_t g, ulong h) + void fmpz_addmul_si(fmpz_t f, const fmpz_t g, slong h) +desc_addmul(f, g, h) + +.. function:: void fmpz_submul(fmpz_t f, const fmpz_t g, const fmpz_t h) + void fmpz_submul_ui(fmpz_t f, const fmpz_t g, ulong h) + void fmpz_submul_si(fmpz_t f, const fmpz_t g, slong h) +desc_submul(f, g, h) .. function:: void fmpz_mul2_uiui(fmpz_t f, const fmpz_t g, ulong x, ulong y) @@ -800,25 +772,11 @@ Basic arithmetic Sets `f` to `2^e`. -.. function:: void fmpz_addmul(fmpz_t f, const fmpz_t g, const fmpz_t h) - void fmpz_addmul_ui(fmpz_t f, const fmpz_t g, ulong h) - void fmpz_addmul_si(fmpz_t f, const fmpz_t g, slong h) - - Sets `f` to `f + g \times h`. - -.. function:: void fmpz_submul(fmpz_t f, const fmpz_t g, const fmpz_t h) - void fmpz_submul_ui(fmpz_t f, const fmpz_t g, ulong h) - void fmpz_submul_si(fmpz_t f, const fmpz_t g, slong h) - - Sets `f` to `f - g \times h`. - .. function:: void fmpz_fmma(fmpz_t f, const fmpz_t a, const fmpz_t b, const fmpz_t c, const fmpz_t d) - - Sets `f` to `a \times b + c \times d`. +desc_fmma(f, a, b, c, d) .. function:: void fmpz_fmms(fmpz_t f, const fmpz_t a, const fmpz_t b, const fmpz_t c, const fmpz_t d) - - Sets `f` to `a \times b - c \times d`. +desc_fmms(f, a, b, c, d) .. function:: void fmpz_cdiv_qr(fmpz_t f, fmpz_t s, const fmpz_t g, const fmpz_t h) @@ -897,16 +855,11 @@ Basic arithmetic If `x` or `y` is `0` an exception is raised. .. function:: int fmpz_divisible(const fmpz_t f, const fmpz_t g) + int fmpz_divisible_si(const fmpz_t f, slong g) +desc_divisible(f, g) -.. function:: int fmpz_divisible_si(const fmpz_t f, slong g) - - Returns `1` if there is an integer `q` with `f = q g` and `0` if there is - none. - -.. function:: int fmpz_divides(fmpz_t q, const fmpz_t g, const fmpz_t h) - - Returns `1` if there is an integer `q` with `f = q g` and sets `q` to the - quotient. Otherwise returns `0` and sets `q` to `0`. +.. function:: int fmpz_divides(fmpz_t f, const fmpz_t g, const fmpz_t h) +desc_divides(f, g, h) .. function:: void fmpz_mod(fmpz_t f, const fmpz_t g, const fmpz_t h) @@ -943,8 +896,7 @@ Basic arithmetic .. function:: void fmpz_pow_ui(fmpz_t f, const fmpz_t g, ulong x) void fmpz_ui_pow_ui(fmpz_t f, ulong g, ulong x) - - Sets `f` to `g^x`. Defines `0^0 = 1`. +desc_pow(f, g, x) .. function:: int fmpz_pow_fmpz(fmpz_t f, const fmpz_t g, const fmpz_t x) @@ -1066,13 +1018,9 @@ Basic arithmetic Greatest common divisor -------------------------------------------------------------------------------- -.. function:: void fmpz_gcd_ui(fmpz_t f, const fmpz_t g, ulong h) - .. function:: void fmpz_gcd(fmpz_t f, const fmpz_t g, const fmpz_t h) - - Sets `f` to the greatest common divisor of `g` and `h`. The - result is always non-negative, even if one of `g` and `h` is - negative. + void fmpz_gcd_ui(fmpz_t f, const fmpz_t g, ulong h) +desc_gcd_int(f, g, h) .. function:: void fmpz_gcd3(fmpz_t f, const fmpz_t a, const fmpz_t b, const fmpz_t c) diff --git a/doc/source/fmpz_extras.rst b/doc/origsrc/fmpz_extras.rst similarity index 99% rename from doc/source/fmpz_extras.rst rename to doc/origsrc/fmpz_extras.rst index bbcad16a5c..00cb7aa7bc 100644 --- a/doc/source/fmpz_extras.rst +++ b/doc/origsrc/fmpz_extras.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz_extras: **fmpz_extras.h** -- extra methods for FLINT integers diff --git a/doc/source/fmpz_factor.rst b/doc/origsrc/fmpz_factor.rst similarity index 99% rename from doc/source/fmpz_factor.rst rename to doc/origsrc/fmpz_factor.rst index b8bca58aa2..bde954996e 100644 --- a/doc/source/fmpz_factor.rst +++ b/doc/origsrc/fmpz_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-factor: **fmpz_factor.h** -- integer factorisation diff --git a/doc/source/fmpz_lll.rst b/doc/origsrc/fmpz_lll.rst similarity index 99% rename from doc/source/fmpz_lll.rst rename to doc/origsrc/fmpz_lll.rst index d2601d2938..52d16fd4bf 100644 --- a/doc/source/fmpz_lll.rst +++ b/doc/origsrc/fmpz_lll.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-lll: **fmpz_lll.h** -- LLL reduction diff --git a/doc/source/fmpz_mat.rst b/doc/origsrc/fmpz_mat.rst similarity index 99% rename from doc/source/fmpz_mat.rst rename to doc/origsrc/fmpz_mat.rst index 684ae2bdbc..0fdde78cf8 100644 --- a/doc/source/fmpz_mat.rst +++ b/doc/origsrc/fmpz_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mat: **fmpz_mat.h** -- matrices over the integers diff --git a/doc/source/fmpz_mod.rst b/doc/origsrc/fmpz_mod.rst similarity index 99% rename from doc/source/fmpz_mod.rst rename to doc/origsrc/fmpz_mod.rst index eca14a0394..71be997433 100644 --- a/doc/source/fmpz_mod.rst +++ b/doc/origsrc/fmpz_mod.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mod: **fmpz_mod.h** -- arithmetic modulo integers diff --git a/doc/source/fmpz_mod_mat.rst b/doc/origsrc/fmpz_mod_mat.rst similarity index 99% rename from doc/source/fmpz_mod_mat.rst rename to doc/origsrc/fmpz_mod_mat.rst index e667b240b0..0f802a64e4 100644 --- a/doc/source/fmpz_mod_mat.rst +++ b/doc/origsrc/fmpz_mod_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz_mod_mat: **fmpz_mod_mat.h** -- matrices over integers mod n diff --git a/doc/source/fmpz_mod_mpoly.rst b/doc/origsrc/fmpz_mod_mpoly.rst similarity index 99% rename from doc/source/fmpz_mod_mpoly.rst rename to doc/origsrc/fmpz_mod_mpoly.rst index 7a40c58829..f2cc9f55d3 100644 --- a/doc/source/fmpz_mod_mpoly.rst +++ b/doc/origsrc/fmpz_mod_mpoly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mod-mpoly: **fmpz_mod_mpoly.h** -- polynomials over the integers mod n diff --git a/doc/source/fmpz_mod_mpoly_factor.rst b/doc/origsrc/fmpz_mod_mpoly_factor.rst similarity index 99% rename from doc/source/fmpz_mod_mpoly_factor.rst rename to doc/origsrc/fmpz_mod_mpoly_factor.rst index eebe1677b1..057fe90dd5 100644 --- a/doc/source/fmpz_mod_mpoly_factor.rst +++ b/doc/origsrc/fmpz_mod_mpoly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mod-mpoly-factor: **fmpz_mod_mpoly_factor.h** -- factorisation of multivariate polynomials over the integers mod n diff --git a/doc/source/fmpz_mod_poly.rst b/doc/origsrc/fmpz_mod_poly.rst similarity index 99% rename from doc/source/fmpz_mod_poly.rst rename to doc/origsrc/fmpz_mod_poly.rst index 566ade3258..ee6ebbb28f 100644 --- a/doc/source/fmpz_mod_poly.rst +++ b/doc/origsrc/fmpz_mod_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mod-poly: **fmpz_mod_poly.h** -- polynomials over integers mod n diff --git a/doc/source/fmpz_mod_poly_factor.rst b/doc/origsrc/fmpz_mod_poly_factor.rst similarity index 99% rename from doc/source/fmpz_mod_poly_factor.rst rename to doc/origsrc/fmpz_mod_poly_factor.rst index 94f43b9bb7..8882e1026a 100644 --- a/doc/source/fmpz_mod_poly_factor.rst +++ b/doc/origsrc/fmpz_mod_poly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mod-poly-factor: **fmpz_mod_poly_factor.h** -- factorisation of polynomials over integers mod n diff --git a/doc/source/fmpz_mod_vec.rst b/doc/origsrc/fmpz_mod_vec.rst similarity index 99% rename from doc/source/fmpz_mod_vec.rst rename to doc/origsrc/fmpz_mod_vec.rst index dd6902b76e..f5d0994509 100644 --- a/doc/source/fmpz_mod_vec.rst +++ b/doc/origsrc/fmpz_mod_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mod-vec: **fmpz_mod_vec.h** -- vectors over integers mod n diff --git a/doc/source/fmpz_mpoly.rst b/doc/origsrc/fmpz_mpoly.rst similarity index 99% rename from doc/source/fmpz_mpoly.rst rename to doc/origsrc/fmpz_mpoly.rst index c8ad7e0e1d..5312cbaf1d 100644 --- a/doc/source/fmpz_mpoly.rst +++ b/doc/origsrc/fmpz_mpoly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mpoly: **fmpz_mpoly.h** -- multivariate polynomials over the integers diff --git a/doc/source/fmpz_mpoly_factor.rst b/doc/origsrc/fmpz_mpoly_factor.rst similarity index 99% rename from doc/source/fmpz_mpoly_factor.rst rename to doc/origsrc/fmpz_mpoly_factor.rst index 84d33bb4d6..b534f538d9 100644 --- a/doc/source/fmpz_mpoly_factor.rst +++ b/doc/origsrc/fmpz_mpoly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mpoly-factor: **fmpz_mpoly_factor.h** -- factorisation of multivariate polynomials over the integers diff --git a/doc/source/fmpz_mpoly_q.rst b/doc/origsrc/fmpz_mpoly_q.rst similarity index 99% rename from doc/source/fmpz_mpoly_q.rst rename to doc/origsrc/fmpz_mpoly_q.rst index 42baa26a88..135e75c62d 100644 --- a/doc/source/fmpz_mpoly_q.rst +++ b/doc/origsrc/fmpz_mpoly_q.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-mpoly-q: **fmpz_mpoly_q.h** -- multivariate rational functions over Q diff --git a/doc/source/fmpz_poly.rst b/doc/origsrc/fmpz_poly.rst similarity index 99% rename from doc/source/fmpz_poly.rst rename to doc/origsrc/fmpz_poly.rst index a2df9dea5f..8ad2c2b8e8 100644 --- a/doc/source/fmpz_poly.rst +++ b/doc/origsrc/fmpz_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-poly: **fmpz_poly.h** -- univariate polynomials over the integers diff --git a/doc/source/fmpz_poly_factor.rst b/doc/origsrc/fmpz_poly_factor.rst similarity index 99% rename from doc/source/fmpz_poly_factor.rst rename to doc/origsrc/fmpz_poly_factor.rst index df6d93e9d8..6299cc8e9b 100644 --- a/doc/source/fmpz_poly_factor.rst +++ b/doc/origsrc/fmpz_poly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-poly-factor: **fmpz_poly_factor.h** -- factorisation of polynomials over the integers diff --git a/doc/source/fmpz_poly_mat.rst b/doc/origsrc/fmpz_poly_mat.rst similarity index 99% rename from doc/source/fmpz_poly_mat.rst rename to doc/origsrc/fmpz_poly_mat.rst index 985f5589d7..d2e09b8920 100644 --- a/doc/source/fmpz_poly_mat.rst +++ b/doc/origsrc/fmpz_poly_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-poly-mat: **fmpz_poly_mat.h** -- matrices of polynomials over the integers diff --git a/doc/source/fmpz_poly_q.rst b/doc/origsrc/fmpz_poly_q.rst similarity index 99% rename from doc/source/fmpz_poly_q.rst rename to doc/origsrc/fmpz_poly_q.rst index 98dc654652..3d468d87ff 100644 --- a/doc/source/fmpz_poly_q.rst +++ b/doc/origsrc/fmpz_poly_q.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-poly-q: **fmpz_poly_q.h** -- rational functions over the rational numbers diff --git a/doc/source/fmpz_vec.rst b/doc/origsrc/fmpz_vec.rst similarity index 99% rename from doc/source/fmpz_vec.rst rename to doc/origsrc/fmpz_vec.rst index 04f4e2437e..2a45ed76e8 100644 --- a/doc/source/fmpz_vec.rst +++ b/doc/origsrc/fmpz_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpz-vec: **fmpz_vec.h** -- vectors of integers diff --git a/doc/source/fmpzi.rst b/doc/origsrc/fmpzi.rst similarity index 99% rename from doc/source/fmpzi.rst rename to doc/origsrc/fmpzi.rst index ebe9fd3c16..6819a86fd9 100644 --- a/doc/source/fmpzi.rst +++ b/doc/origsrc/fmpzi.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fmpzi: **fmpzi.h** -- Gaussian integers diff --git a/doc/source/formulas.rst b/doc/origsrc/formulas.rst similarity index 99% rename from doc/source/formulas.rst rename to doc/origsrc/formulas.rst index 5815d18390..41f5712278 100644 --- a/doc/source/formulas.rst +++ b/doc/origsrc/formulas.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _general_formulas: General formulas and bounds diff --git a/doc/source/fq.rst b/doc/origsrc/fq.rst similarity index 99% rename from doc/source/fq.rst rename to doc/origsrc/fq.rst index f97caf31fd..180d0c1b37 100644 --- a/doc/source/fq.rst +++ b/doc/origsrc/fq.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq: **fq.h** -- finite fields diff --git a/doc/source/fq_default.rst b/doc/origsrc/fq_default.rst similarity index 99% rename from doc/source/fq_default.rst rename to doc/origsrc/fq_default.rst index 190da0c868..e1a085aff2 100644 --- a/doc/source/fq_default.rst +++ b/doc/origsrc/fq_default.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq_default: **fq_default.h** -- unified finite fields diff --git a/doc/source/fq_default_mat.rst b/doc/origsrc/fq_default_mat.rst similarity index 99% rename from doc/source/fq_default_mat.rst rename to doc/origsrc/fq_default_mat.rst index 88e8573ecc..26256c34cd 100644 --- a/doc/source/fq_default_mat.rst +++ b/doc/origsrc/fq_default_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq_default_mat: **fq_default_mat.h** -- matrices over finite fields diff --git a/doc/source/fq_default_poly.rst b/doc/origsrc/fq_default_poly.rst similarity index 99% rename from doc/source/fq_default_poly.rst rename to doc/origsrc/fq_default_poly.rst index 213fb0474a..123e184884 100644 --- a/doc/source/fq_default_poly.rst +++ b/doc/origsrc/fq_default_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq_default_poly: **fq_default_poly.h** -- univariate polynomials over finite fields diff --git a/doc/source/fq_default_poly_factor.rst b/doc/origsrc/fq_default_poly_factor.rst similarity index 99% rename from doc/source/fq_default_poly_factor.rst rename to doc/origsrc/fq_default_poly_factor.rst index 842897c602..ae315a71f6 100644 --- a/doc/source/fq_default_poly_factor.rst +++ b/doc/origsrc/fq_default_poly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-poly_factor: **fq_default_poly_factor.h** -- factorisation of univariate polynomials over finite fields diff --git a/doc/source/fq_embed.rst b/doc/origsrc/fq_embed.rst similarity index 99% rename from doc/source/fq_embed.rst rename to doc/origsrc/fq_embed.rst index 6d4c84daf4..e256706b2c 100644 --- a/doc/source/fq_embed.rst +++ b/doc/origsrc/fq_embed.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-embed: **fq_embed.h** -- Computing isomorphisms and embeddings of finite fields diff --git a/doc/source/fq_mat.rst b/doc/origsrc/fq_mat.rst similarity index 99% rename from doc/source/fq_mat.rst rename to doc/origsrc/fq_mat.rst index 9814c80dd1..132deefb1d 100644 --- a/doc/source/fq_mat.rst +++ b/doc/origsrc/fq_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-mat: **fq_mat.h** -- matrices over finite fields diff --git a/doc/source/fq_nmod.rst b/doc/origsrc/fq_nmod.rst similarity index 99% rename from doc/source/fq_nmod.rst rename to doc/origsrc/fq_nmod.rst index 0e34f03f23..a6dfc8d6a2 100644 --- a/doc/source/fq_nmod.rst +++ b/doc/origsrc/fq_nmod.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-nmod: **fq_nmod.h** -- finite fields (word-size characteristic) diff --git a/doc/source/fq_nmod_embed.rst b/doc/origsrc/fq_nmod_embed.rst similarity index 99% rename from doc/source/fq_nmod_embed.rst rename to doc/origsrc/fq_nmod_embed.rst index 876d9c0ec5..13d69b6975 100644 --- a/doc/source/fq_nmod_embed.rst +++ b/doc/origsrc/fq_nmod_embed.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-nmod-embed: **fq_nmod_embed.h** -- Computing isomorphisms and embeddings of finite fields diff --git a/doc/source/fq_nmod_mat.rst b/doc/origsrc/fq_nmod_mat.rst similarity index 99% rename from doc/source/fq_nmod_mat.rst rename to doc/origsrc/fq_nmod_mat.rst index 9ca80b7435..3adb028e42 100644 --- a/doc/source/fq_nmod_mat.rst +++ b/doc/origsrc/fq_nmod_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-nmod-mat: **fq_nmod_mat.h** -- matrices over finite fields (word-size characteristic) diff --git a/doc/source/fq_nmod_mpoly.rst b/doc/origsrc/fq_nmod_mpoly.rst similarity index 99% rename from doc/source/fq_nmod_mpoly.rst rename to doc/origsrc/fq_nmod_mpoly.rst index 567e93491d..71c6e2e81d 100644 --- a/doc/source/fq_nmod_mpoly.rst +++ b/doc/origsrc/fq_nmod_mpoly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq_nmod-mpoly: **fq_nmod_mpoly.h** -- multivariate polynomials over finite fields of word-sized characteristic diff --git a/doc/source/fq_nmod_mpoly_factor.rst b/doc/origsrc/fq_nmod_mpoly_factor.rst similarity index 99% rename from doc/source/fq_nmod_mpoly_factor.rst rename to doc/origsrc/fq_nmod_mpoly_factor.rst index 7281ae792d..df6f9c78fa 100644 --- a/doc/source/fq_nmod_mpoly_factor.rst +++ b/doc/origsrc/fq_nmod_mpoly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq_nmod-mpoly-factor: **fq_nmod_mpoly_factor.h** -- factorisation of multivariate polynomials over finite fields of word-sized characteristic diff --git a/doc/source/fq_nmod_poly.rst b/doc/origsrc/fq_nmod_poly.rst similarity index 99% rename from doc/source/fq_nmod_poly.rst rename to doc/origsrc/fq_nmod_poly.rst index a38a702f99..640515593f 100644 --- a/doc/source/fq_nmod_poly.rst +++ b/doc/origsrc/fq_nmod_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-nmod-poly: **fq_nmod_poly.h** -- univariate polynomials over finite fields (word-size characteristic) diff --git a/doc/source/fq_nmod_poly_factor.rst b/doc/origsrc/fq_nmod_poly_factor.rst similarity index 99% rename from doc/source/fq_nmod_poly_factor.rst rename to doc/origsrc/fq_nmod_poly_factor.rst index 10350b97f7..7a87ce313e 100644 --- a/doc/source/fq_nmod_poly_factor.rst +++ b/doc/origsrc/fq_nmod_poly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-nmod-poly-factor: **fq_nmod_poly_factor.h** -- factorisation of univariate polynomials over finite fields (word-size characteristic) diff --git a/doc/source/fq_nmod_vec.rst b/doc/origsrc/fq_nmod_vec.rst similarity index 99% rename from doc/source/fq_nmod_vec.rst rename to doc/origsrc/fq_nmod_vec.rst index e3d9f87706..98901166a9 100644 --- a/doc/source/fq_nmod_vec.rst +++ b/doc/origsrc/fq_nmod_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-nmod-vec: **fq_nmod_vec.h** -- vectors over finite fields (word-size characteristic) diff --git a/doc/source/fq_poly.rst b/doc/origsrc/fq_poly.rst similarity index 99% rename from doc/source/fq_poly.rst rename to doc/origsrc/fq_poly.rst index 6a047bfba3..ea450f9e3d 100644 --- a/doc/source/fq_poly.rst +++ b/doc/origsrc/fq_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-poly: **fq_poly.h** -- univariate polynomials over finite fields diff --git a/doc/source/fq_poly_factor.rst b/doc/origsrc/fq_poly_factor.rst similarity index 99% rename from doc/source/fq_poly_factor.rst rename to doc/origsrc/fq_poly_factor.rst index b1e98c0438..15b11e8bd4 100644 --- a/doc/source/fq_poly_factor.rst +++ b/doc/origsrc/fq_poly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-poly-factor: **fq_poly_factor.h** -- factorisation of univariate polynomials over finite fields diff --git a/doc/source/fq_vec.rst b/doc/origsrc/fq_vec.rst similarity index 99% rename from doc/source/fq_vec.rst rename to doc/origsrc/fq_vec.rst index 8e7e78267b..dd6cd505ac 100644 --- a/doc/source/fq_vec.rst +++ b/doc/origsrc/fq_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-vec: **fq_vec.h** -- vectors over finite fields diff --git a/doc/source/fq_zech.rst b/doc/origsrc/fq_zech.rst similarity index 99% rename from doc/source/fq_zech.rst rename to doc/origsrc/fq_zech.rst index efc1e6f17c..db4ef814d9 100644 --- a/doc/source/fq_zech.rst +++ b/doc/origsrc/fq_zech.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-zech: **fq_zech.h** -- finite fields (Zech logarithm representation) diff --git a/doc/source/fq_zech_embed.rst b/doc/origsrc/fq_zech_embed.rst similarity index 99% rename from doc/source/fq_zech_embed.rst rename to doc/origsrc/fq_zech_embed.rst index 2511f5d57b..140b006981 100644 --- a/doc/source/fq_zech_embed.rst +++ b/doc/origsrc/fq_zech_embed.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-zech-embed: **fq_zech_embed.h** -- Computing isomorphisms and embeddings of finite fields diff --git a/doc/source/fq_zech_mat.rst b/doc/origsrc/fq_zech_mat.rst similarity index 99% rename from doc/source/fq_zech_mat.rst rename to doc/origsrc/fq_zech_mat.rst index dda2515d6c..3c59acea1f 100644 --- a/doc/source/fq_zech_mat.rst +++ b/doc/origsrc/fq_zech_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-zech-mat: **fq_zech_mat.h** -- matrices over finite fields (Zech logarithm representation) diff --git a/doc/source/fq_zech_poly.rst b/doc/origsrc/fq_zech_poly.rst similarity index 99% rename from doc/source/fq_zech_poly.rst rename to doc/origsrc/fq_zech_poly.rst index 6d76c9fac7..607cb9b86e 100644 --- a/doc/source/fq_zech_poly.rst +++ b/doc/origsrc/fq_zech_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-zech-poly: **fq_zech_poly.h** -- univariate polynomials over finite fields (Zech logarithm representation) diff --git a/doc/source/fq_zech_poly_factor.rst b/doc/origsrc/fq_zech_poly_factor.rst similarity index 99% rename from doc/source/fq_zech_poly_factor.rst rename to doc/origsrc/fq_zech_poly_factor.rst index 256b437bea..01fab9d822 100644 --- a/doc/source/fq_zech_poly_factor.rst +++ b/doc/origsrc/fq_zech_poly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-zech-poly-factor: **fq_zech_poly_factor.h** -- factorisation of univariate polynomials over finite fields (Zech logarithm representation) diff --git a/doc/source/fq_zech_vec.rst b/doc/origsrc/fq_zech_vec.rst similarity index 99% rename from doc/source/fq_zech_vec.rst rename to doc/origsrc/fq_zech_vec.rst index a4d383ec8b..a249dde9f6 100644 --- a/doc/source/fq_zech_vec.rst +++ b/doc/origsrc/fq_zech_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _fq-zech-vec: **fq_zech_vec.h** -- vectors over finite fields (Zech logarithm representation) diff --git a/doc/source/gamma.rst b/doc/origsrc/gamma.rst similarity index 99% rename from doc/source/gamma.rst rename to doc/origsrc/gamma.rst index c2ea71cd81..071160af08 100644 --- a/doc/source/gamma.rst +++ b/doc/origsrc/gamma.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _algorithms_gamma: Algorithms for the gamma function diff --git a/doc/source/gr.rst b/doc/origsrc/gr.rst similarity index 99% rename from doc/source/gr.rst rename to doc/origsrc/gr.rst index 79992c8a4d..a8cd5e75a7 100644 --- a/doc/source/gr.rst +++ b/doc/origsrc/gr.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr: **gr.h** -- generic structures and their elements diff --git a/doc/source/gr_domains.rst b/doc/origsrc/gr_domains.rst similarity index 99% rename from doc/source/gr_domains.rst rename to doc/origsrc/gr_domains.rst index 67658cfc8b..e4bee6057e 100644 --- a/doc/source/gr_domains.rst +++ b/doc/origsrc/gr_domains.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr-domains: **gr.h (continued)** -- builtin domains and types diff --git a/doc/source/gr_generic.rst b/doc/origsrc/gr_generic.rst similarity index 99% rename from doc/source/gr_generic.rst rename to doc/origsrc/gr_generic.rst index 4defbb6c36..53077bfa8e 100644 --- a/doc/source/gr_generic.rst +++ b/doc/origsrc/gr_generic.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr-generic: **gr_generic.h** -- basic algorithms and fallback implementations for generic elements diff --git a/doc/source/gr_implementing.rst b/doc/origsrc/gr_implementing.rst similarity index 99% rename from doc/source/gr_implementing.rst rename to doc/origsrc/gr_implementing.rst index 281a91fc53..933c3f2762 100644 --- a/doc/source/gr_implementing.rst +++ b/doc/origsrc/gr_implementing.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr-implementing: **gr.h (continued)** -- implementing rings diff --git a/doc/source/gr_mat.rst b/doc/origsrc/gr_mat.rst similarity index 99% rename from doc/source/gr_mat.rst rename to doc/origsrc/gr_mat.rst index 9ea85cddc8..da09fcd894 100644 --- a/doc/source/gr_mat.rst +++ b/doc/origsrc/gr_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr-mat: **gr_mat.h** -- dense matrices over generic rings diff --git a/doc/source/gr_mpoly.rst b/doc/origsrc/gr_mpoly.rst similarity index 99% rename from doc/source/gr_mpoly.rst rename to doc/origsrc/gr_mpoly.rst index 1a8c8a08f1..36fc49c9d4 100644 --- a/doc/source/gr_mpoly.rst +++ b/doc/origsrc/gr_mpoly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr-mpoly: **gr_mpoly.h** -- sparse multivariate polynomials over generic rings diff --git a/doc/source/gr_poly.rst b/doc/origsrc/gr_poly.rst similarity index 99% rename from doc/source/gr_poly.rst rename to doc/origsrc/gr_poly.rst index 810f914087..ca8afb558c 100644 --- a/doc/source/gr_poly.rst +++ b/doc/origsrc/gr_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr-poly: **gr_poly.h** -- dense univariate polynomials over generic rings diff --git a/doc/source/gr_special.rst b/doc/origsrc/gr_special.rst similarity index 99% rename from doc/source/gr_special.rst rename to doc/origsrc/gr_special.rst index 68c68793be..7b5c777592 100644 --- a/doc/source/gr_special.rst +++ b/doc/origsrc/gr_special.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr-special: **gr_special.h** -- special arithmetic and transcendental functions diff --git a/doc/source/gr_vec.rst b/doc/origsrc/gr_vec.rst similarity index 99% rename from doc/source/gr_vec.rst rename to doc/origsrc/gr_vec.rst index db158b380a..e80128a4ab 100644 --- a/doc/source/gr_vec.rst +++ b/doc/origsrc/gr_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _gr-vec: **gr_vec.h** -- vectors over generic rings diff --git a/doc/source/history.rst b/doc/origsrc/history.rst similarity index 99% rename from doc/source/history.rst rename to doc/origsrc/history.rst index aefb1a19b9..519d107582 100644 --- a/doc/source/history.rst +++ b/doc/origsrc/history.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _history: History and changes diff --git a/doc/source/hurwitz.rst b/doc/origsrc/hurwitz.rst similarity index 98% rename from doc/source/hurwitz.rst rename to doc/origsrc/hurwitz.rst index 50ac135823..b609c47767 100644 --- a/doc/source/hurwitz.rst +++ b/doc/origsrc/hurwitz.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _algorithms_hurwitz: Algorithms for the Hurwitz zeta function diff --git a/doc/source/hypergeometric.rst b/doc/origsrc/hypergeometric.rst similarity index 99% rename from doc/source/hypergeometric.rst rename to doc/origsrc/hypergeometric.rst index e602d9c2bf..5d3c3b1eef 100644 --- a/doc/source/hypergeometric.rst +++ b/doc/origsrc/hypergeometric.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _algorithms_hypergeometric: Algorithms for hypergeometric functions diff --git a/doc/source/hypgeom.rst b/doc/origsrc/hypgeom.rst similarity index 99% rename from doc/source/hypgeom.rst rename to doc/origsrc/hypgeom.rst index dc25d800db..26dfc55771 100644 --- a/doc/source/hypgeom.rst +++ b/doc/origsrc/hypgeom.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _hypgeom: **hypgeom.h** -- support for hypergeometric series diff --git a/doc/source/index.rst b/doc/origsrc/index.rst similarity index 99% rename from doc/source/index.rst rename to doc/origsrc/index.rst index a2012745a9..4d8b8d83b3 100644 --- a/doc/source/index.rst +++ b/doc/origsrc/index.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. FLINT documentation master file, created by sphinx-quickstart on Fri Nov 16 21:59:21 2018. You can adapt this file completely to your liking, but it should at least diff --git a/doc/source/index_arb.rst b/doc/origsrc/index_arb.rst similarity index 99% rename from doc/source/index_arb.rst rename to doc/origsrc/index_arb.rst index 1505571700..8eb6d38e51 100644 --- a/doc/source/index_arb.rst +++ b/doc/origsrc/index_arb.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _index-arb: **Real and complex numbers (Arb)** : *detailed table of contents* diff --git a/doc/source/index_generic.rst b/doc/origsrc/index_generic.rst similarity index 93% rename from doc/source/index_generic.rst rename to doc/origsrc/index_generic.rst index e435030fdf..27d05c2b96 100644 --- a/doc/source/index_generic.rst +++ b/doc/origsrc/index_generic.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _index-generic: **Generic rings** : *detailed table of contents* diff --git a/doc/source/index_integers.rst b/doc/origsrc/index_integers.rst similarity index 95% rename from doc/source/index_integers.rst rename to doc/origsrc/index_integers.rst index 4b7853ac79..426a663b7a 100644 --- a/doc/source/index_integers.rst +++ b/doc/origsrc/index_integers.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _index-integers: **Integers** : *detailed table of contents* diff --git a/doc/source/index_integers_mod.rst b/doc/origsrc/index_integers_mod.rst similarity index 95% rename from doc/source/index_integers_mod.rst rename to doc/origsrc/index_integers_mod.rst index 719a7babf6..2e2528f691 100644 --- a/doc/source/index_integers_mod.rst +++ b/doc/origsrc/index_integers_mod.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _index-integers-mod: **Integers mod n** : *detailed table of contents* diff --git a/doc/source/index_rationals.rst b/doc/origsrc/index_rationals.rst similarity index 93% rename from doc/source/index_rationals.rst rename to doc/origsrc/index_rationals.rst index 7d75c5f6ef..201af80cc7 100644 --- a/doc/source/index_rationals.rst +++ b/doc/origsrc/index_rationals.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _index-rationals: **Rational numbers** : *detailed table of contents* diff --git a/doc/source/introduction.rst b/doc/origsrc/introduction.rst similarity index 99% rename from doc/source/introduction.rst rename to doc/origsrc/introduction.rst index 01575b5816..6a0baec75f 100644 --- a/doc/source/introduction.rst +++ b/doc/origsrc/introduction.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _introduction: **Introduction** diff --git a/doc/source/introduction_calcium.rst b/doc/origsrc/introduction_calcium.rst similarity index 99% rename from doc/source/introduction_calcium.rst rename to doc/origsrc/introduction_calcium.rst index 899fc5af7a..359a801c82 100644 --- a/doc/source/introduction_calcium.rst +++ b/doc/origsrc/introduction_calcium.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _introduction-calcium: Introduction diff --git a/doc/source/issues.rst b/doc/origsrc/issues.rst similarity index 99% rename from doc/source/issues.rst rename to doc/origsrc/issues.rst index 3e9827b176..ce2f96e3ee 100644 --- a/doc/source/issues.rst +++ b/doc/origsrc/issues.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _issues: Technical conventions and potential issues diff --git a/doc/source/long_extras.rst b/doc/origsrc/long_extras.rst similarity index 98% rename from doc/source/long_extras.rst rename to doc/origsrc/long_extras.rst index a9f90d511c..740b6cfba7 100644 --- a/doc/source/long_extras.rst +++ b/doc/origsrc/long_extras.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _long-extras: **long_extras.h** -- support functions for signed word arithmetic diff --git a/doc/source/longlong.rst b/doc/origsrc/longlong.rst similarity index 99% rename from doc/source/longlong.rst rename to doc/origsrc/longlong.rst index bcfdd6cf67..9055aad53d 100644 --- a/doc/source/longlong.rst +++ b/doc/origsrc/longlong.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _longlong: **longlong.h** -- support functions for multi-word arithmetic diff --git a/doc/source/machine_vectors.rst b/doc/origsrc/machine_vectors.rst similarity index 99% rename from doc/source/machine_vectors.rst rename to doc/origsrc/machine_vectors.rst index e10c79a53e..bbb48e408a 100644 --- a/doc/source/machine_vectors.rst +++ b/doc/origsrc/machine_vectors.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _machine-vectors: **machine_vectors.h** -- SIMD-accelerated operations on fixed-length vectors diff --git a/doc/source/mag.rst b/doc/origsrc/mag.rst similarity index 99% rename from doc/source/mag.rst rename to doc/origsrc/mag.rst index 4a18c5b986..50c6315ef0 100644 --- a/doc/source/mag.rst +++ b/doc/origsrc/mag.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _mag: **mag.h** -- fixed-precision unsigned floating-point numbers for bounds diff --git a/doc/source/memory.rst b/doc/origsrc/memory.rst similarity index 99% rename from doc/source/memory.rst rename to doc/origsrc/memory.rst index 44f0aab9a6..91f0545570 100644 --- a/doc/source/memory.rst +++ b/doc/origsrc/memory.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _memory: **Memory management** diff --git a/doc/source/mpfr_mat.rst b/doc/origsrc/mpfr_mat.rst similarity index 98% rename from doc/source/mpfr_mat.rst rename to doc/origsrc/mpfr_mat.rst index cc3ad6eee6..596e211791 100644 --- a/doc/source/mpfr_mat.rst +++ b/doc/origsrc/mpfr_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _mpfr-mat: **mpfr_mat.h** -- matrices of MPFR floating-point numbers diff --git a/doc/source/mpfr_vec.rst b/doc/origsrc/mpfr_vec.rst similarity index 97% rename from doc/source/mpfr_vec.rst rename to doc/origsrc/mpfr_vec.rst index 84631ebdf7..eddd4d1a21 100644 --- a/doc/source/mpfr_vec.rst +++ b/doc/origsrc/mpfr_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _mpfr-vec: **mpfr_vec.h** -- vectors of MPFR floating-point numbers diff --git a/doc/source/mpn_extras.rst b/doc/origsrc/mpn_extras.rst similarity index 99% rename from doc/source/mpn_extras.rst rename to doc/origsrc/mpn_extras.rst index 9921451b22..ea2072c36e 100644 --- a/doc/source/mpn_extras.rst +++ b/doc/origsrc/mpn_extras.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _mpn-extras: **mpn_extras.h** -- support functions for limb arrays diff --git a/doc/source/mpn_mod.rst b/doc/origsrc/mpn_mod.rst similarity index 99% rename from doc/source/mpn_mod.rst rename to doc/origsrc/mpn_mod.rst index 3ce0598566..83ae9f7d23 100644 --- a/doc/source/mpn_mod.rst +++ b/doc/origsrc/mpn_mod.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _mpn-mod: **mpn_mod.h** -- integers mod n (packed multi-word n) diff --git a/doc/source/mpoly.rst b/doc/origsrc/mpoly.rst similarity index 99% rename from doc/source/mpoly.rst rename to doc/origsrc/mpoly.rst index 55f2cce507..452fcfa00a 100644 --- a/doc/source/mpoly.rst +++ b/doc/origsrc/mpoly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _mpoly: **mpoly.h** -- support functions for multivariate polynomials diff --git a/doc/source/nf.rst b/doc/origsrc/nf.rst similarity index 95% rename from doc/source/nf.rst rename to doc/origsrc/nf.rst index ce5825e775..c4e8685b78 100644 --- a/doc/source/nf.rst +++ b/doc/origsrc/nf.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nf: **nf.h** -- number fields diff --git a/doc/source/nf_elem.rst b/doc/origsrc/nf_elem.rst similarity index 99% rename from doc/source/nf_elem.rst rename to doc/origsrc/nf_elem.rst index f95ca1de6b..99a7c2339d 100644 --- a/doc/source/nf_elem.rst +++ b/doc/origsrc/nf_elem.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nf_elem: **nf_elem.h** -- number field elements diff --git a/doc/source/nfloat.rst b/doc/origsrc/nfloat.rst similarity index 99% rename from doc/source/nfloat.rst rename to doc/origsrc/nfloat.rst index 9ac02883cd..c21e6ee1a3 100644 --- a/doc/source/nfloat.rst +++ b/doc/origsrc/nfloat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nfloat: **nfloat.h** -- packed floating-point numbers with n-word precision diff --git a/doc/source/nmod.rst b/doc/origsrc/nmod.rst similarity index 99% rename from doc/source/nmod.rst rename to doc/origsrc/nmod.rst index fcb5921812..d900f54dd1 100644 --- a/doc/source/nmod.rst +++ b/doc/origsrc/nmod.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nmod: **nmod.h** -- integers mod n (word-size n) diff --git a/doc/source/nmod_mat.rst b/doc/origsrc/nmod_mat.rst similarity index 99% rename from doc/source/nmod_mat.rst rename to doc/origsrc/nmod_mat.rst index b1da8f22ca..f2582b0c58 100644 --- a/doc/source/nmod_mat.rst +++ b/doc/origsrc/nmod_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nmod-mat: **nmod_mat.h** -- matrices over integers mod n (word-size n) diff --git a/doc/source/nmod_mpoly.rst b/doc/origsrc/nmod_mpoly.rst similarity index 99% rename from doc/source/nmod_mpoly.rst rename to doc/origsrc/nmod_mpoly.rst index 7553315112..3aec8bc877 100644 --- a/doc/source/nmod_mpoly.rst +++ b/doc/origsrc/nmod_mpoly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nmod-mpoly: **nmod_mpoly.h** -- multivariate polynomials over integers mod n (word-size n) diff --git a/doc/source/nmod_mpoly_factor.rst b/doc/origsrc/nmod_mpoly_factor.rst similarity index 99% rename from doc/source/nmod_mpoly_factor.rst rename to doc/origsrc/nmod_mpoly_factor.rst index c6d39ddf00..80b58a546f 100644 --- a/doc/source/nmod_mpoly_factor.rst +++ b/doc/origsrc/nmod_mpoly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nmod-mpoly-factor: **nmod_mpoly_factor.h** -- factorisation of multivariate polynomials over integers mod n (word-size n) diff --git a/doc/source/nmod_poly.rst b/doc/origsrc/nmod_poly.rst similarity index 99% rename from doc/source/nmod_poly.rst rename to doc/origsrc/nmod_poly.rst index 6bb0e4d6ee..9975d10a60 100644 --- a/doc/source/nmod_poly.rst +++ b/doc/origsrc/nmod_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nmod-poly: **nmod_poly.h** -- univariate polynomials over integers mod n (word-size n) diff --git a/doc/source/nmod_poly_factor.rst b/doc/origsrc/nmod_poly_factor.rst similarity index 99% rename from doc/source/nmod_poly_factor.rst rename to doc/origsrc/nmod_poly_factor.rst index a9b9a6bf4e..17c1415d84 100644 --- a/doc/source/nmod_poly_factor.rst +++ b/doc/origsrc/nmod_poly_factor.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nmod-poly-factor: **nmod_poly_factor.h** -- factorisation of univariate polynomials over integers mod n (word-size n) diff --git a/doc/source/nmod_poly_mat.rst b/doc/origsrc/nmod_poly_mat.rst similarity index 99% rename from doc/source/nmod_poly_mat.rst rename to doc/origsrc/nmod_poly_mat.rst index 1979f2243b..091a6fce54 100644 --- a/doc/source/nmod_poly_mat.rst +++ b/doc/origsrc/nmod_poly_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nmod-poly-mat: **nmod_poly_mat.h** -- matrices of univariate polynomials over integers mod n (word-size n) diff --git a/doc/source/nmod_vec.rst b/doc/origsrc/nmod_vec.rst similarity index 99% rename from doc/source/nmod_vec.rst rename to doc/origsrc/nmod_vec.rst index 55c4e6c14d..ae988853dd 100644 --- a/doc/source/nmod_vec.rst +++ b/doc/origsrc/nmod_vec.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _nmod-vec: **nmod_vec.h** -- vectors over integers mod n (word-size n) diff --git a/doc/source/overview.rst b/doc/origsrc/overview.rst similarity index 99% rename from doc/source/overview.rst rename to doc/origsrc/overview.rst index 9f797c43ed..6dc8022df9 100644 --- a/doc/source/overview.rst +++ b/doc/origsrc/overview.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _overview: Feature overview diff --git a/doc/source/padic.rst b/doc/origsrc/padic.rst similarity index 99% rename from doc/source/padic.rst rename to doc/origsrc/padic.rst index f7ac874b4b..09e7cea1f1 100644 --- a/doc/source/padic.rst +++ b/doc/origsrc/padic.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _padic: **padic.h** -- p-adic numbers diff --git a/doc/source/padic_mat.rst b/doc/origsrc/padic_mat.rst similarity index 99% rename from doc/source/padic_mat.rst rename to doc/origsrc/padic_mat.rst index da8d19a3f9..3dbe72a908 100644 --- a/doc/source/padic_mat.rst +++ b/doc/origsrc/padic_mat.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _padic-mat: **padic_mat.h** -- matrices over p-adic numbers diff --git a/doc/source/padic_poly.rst b/doc/origsrc/padic_poly.rst similarity index 99% rename from doc/source/padic_poly.rst rename to doc/origsrc/padic_poly.rst index 9d7c8c657b..ae13acfa2b 100644 --- a/doc/source/padic_poly.rst +++ b/doc/origsrc/padic_poly.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _padic-poly: **padic_poly.h** -- polynomials over p-adic numbers diff --git a/doc/source/partitions.rst b/doc/origsrc/partitions.rst similarity index 99% rename from doc/source/partitions.rst rename to doc/origsrc/partitions.rst index 3b2aca6ed4..b95e71cdea 100644 --- a/doc/source/partitions.rst +++ b/doc/origsrc/partitions.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _partitions: **partitions.h** -- computation of the partition function diff --git a/doc/source/perm.rst b/doc/origsrc/perm.rst similarity index 98% rename from doc/source/perm.rst rename to doc/origsrc/perm.rst index 9dfde7fe80..ac4d9555e1 100644 --- a/doc/source/perm.rst +++ b/doc/origsrc/perm.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _perm: **perm.h** -- permutations diff --git a/doc/source/polylogarithms.rst b/doc/origsrc/polylogarithms.rst similarity index 99% rename from doc/source/polylogarithms.rst rename to doc/origsrc/polylogarithms.rst index b26c32cddf..1ca47cfc11 100644 --- a/doc/source/polylogarithms.rst +++ b/doc/origsrc/polylogarithms.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _algorithms_polylogarithms: Algorithms for polylogarithms diff --git a/doc/source/portability.rst b/doc/origsrc/portability.rst similarity index 98% rename from doc/source/portability.rst rename to doc/origsrc/portability.rst index 96531d2a66..1b3cea0edc 100644 --- a/doc/source/portability.rst +++ b/doc/origsrc/portability.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _portability: **Portability** diff --git a/doc/source/profiler.rst b/doc/origsrc/profiler.rst similarity index 99% rename from doc/source/profiler.rst rename to doc/origsrc/profiler.rst index abb5c613a6..3411f0c3d7 100644 --- a/doc/source/profiler.rst +++ b/doc/origsrc/profiler.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _profiler: **profiler.h** -- performance profiling diff --git a/doc/source/python_flint.rst b/doc/origsrc/python_flint.rst similarity index 98% rename from doc/source/python_flint.rst rename to doc/origsrc/python_flint.rst index 499cdd5a99..8f4cd1eba6 100644 --- a/doc/source/python_flint.rst +++ b/doc/origsrc/python_flint.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _pyflint: **flint_ctypes** - Python interface diff --git a/doc/source/qadic.rst b/doc/origsrc/qadic.rst similarity index 99% rename from doc/source/qadic.rst rename to doc/origsrc/qadic.rst index 22d48d0434..30cc0540eb 100644 --- a/doc/source/qadic.rst +++ b/doc/origsrc/qadic.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _qadic: **qadic.h** -- unramified extensions over p-adic numbers diff --git a/doc/source/qfb.rst b/doc/origsrc/qfb.rst similarity index 99% rename from doc/source/qfb.rst rename to doc/origsrc/qfb.rst index cc6290bc95..6aec06673a 100644 --- a/doc/source/qfb.rst +++ b/doc/origsrc/qfb.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _qfb: **qfb.h** -- binary quadratic forms diff --git a/doc/source/qqbar.rst b/doc/origsrc/qqbar.rst similarity index 99% rename from doc/source/qqbar.rst rename to doc/origsrc/qqbar.rst index 45ecb00a2e..8c09e339b9 100644 --- a/doc/source/qqbar.rst +++ b/doc/origsrc/qqbar.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _qqbar: **qqbar.h** -- algebraic numbers represented by minimal polynomials diff --git a/doc/source/qsieve.rst b/doc/origsrc/qsieve.rst similarity index 99% rename from doc/source/qsieve.rst rename to doc/origsrc/qsieve.rst index cd497140a3..c94d0e9ef1 100644 --- a/doc/source/qsieve.rst +++ b/doc/origsrc/qsieve.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _qsieve: **qsieve.h** -- Quadratic sieve diff --git a/doc/source/references.rst b/doc/origsrc/references.rst similarity index 99% rename from doc/source/references.rst rename to doc/origsrc/references.rst index 83ed474d26..99563d3ec9 100644 --- a/doc/source/references.rst +++ b/doc/origsrc/references.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl References ------------ diff --git a/doc/source/thread_pool.rst b/doc/origsrc/thread_pool.rst similarity index 98% rename from doc/source/thread_pool.rst rename to doc/origsrc/thread_pool.rst index 028f8e0104..db25e5b076 100644 --- a/doc/source/thread_pool.rst +++ b/doc/origsrc/thread_pool.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _thread-pool: **thread_pool.h** -- thread pool diff --git a/doc/source/threading.rst b/doc/origsrc/threading.rst similarity index 99% rename from doc/source/threading.rst rename to doc/origsrc/threading.rst index 815544fe19..e9c400c1d6 100644 --- a/doc/source/threading.rst +++ b/doc/origsrc/threading.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _threading: **Threading** diff --git a/doc/source/ulong_extras.rst b/doc/origsrc/ulong_extras.rst similarity index 99% rename from doc/source/ulong_extras.rst rename to doc/origsrc/ulong_extras.rst index 9e3e30f244..91c7248ddf 100644 --- a/doc/source/ulong_extras.rst +++ b/doc/origsrc/ulong_extras.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _ulong-extras: **ulong_extras.h** -- arithmetic and number-theoretic functions for single-word integers diff --git a/doc/source/using.rst b/doc/origsrc/using.rst similarity index 99% rename from doc/source/using.rst rename to doc/origsrc/using.rst index 04ec07a033..6848829211 100644 --- a/doc/source/using.rst +++ b/doc/origsrc/using.rst @@ -1,3 +1,4 @@ +include(`macros.m4')dnl .. _using: Using ball arithmetic