Skip to content

Commit da51359

Browse files
Try to fix the doc
1 parent 0af9f37 commit da51359

File tree

7 files changed

+174
-146
lines changed

7 files changed

+174
-146
lines changed

docs/source/data-structures/elements/transformations/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,6 @@ This page describes the functionality for various partial transformations in
1919
transf
2020
helpers
2121

22-
See also :any:`hpcombi.PTransf16`.
22+
.. ifconfig:: LIBSEMIGROUPS_HPCOMBI_ENABLED
23+
24+
See also :any:`hpcombi.PTransf16`.

docs/source/data-structures/hpcombi/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,11 @@ This page describes the functionality from ``HPCombi`` available in
3131
ptransf16
3232
transf16
3333
vect16
34+
35+
.. ifconfig:: not LIBSEMIGROUPS_HPCOMBI_ENABLED
36+
37+
.. warning::
38+
39+
It appears that the version of ``libsemigroups`` used with
40+
``libsemigroups_pybind11`` was not compiled with ``HPCombi`` enabled
41+
and so none of the functionality of ``HPCombi`` is available.

docs/source/data-structures/hpcombi/perm16.rst

Lines changed: 56 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,59 @@
88
.. currentmodule:: libsemigroups_pybind11.hpcombi
99

1010
The Perm16 class
11-
==================
12-
13-
.. autoclass:: Perm16
14-
:doc-only:
15-
16-
Contents
17-
--------
18-
19-
.. autosummary::
20-
:signatures: short
21-
22-
~Perm16
23-
Perm16.copy
24-
Perm16.cycles_partition
25-
Perm16.elementary_transposition
26-
Perm16.inverse
27-
Perm16.inverse_arr
28-
Perm16.inverse_cycl
29-
Perm16.inverse_find
30-
Perm16.inverse_pow
31-
Perm16.inverse_ref
32-
Perm16.inverse_sort
33-
Perm16.left_weak_leq
34-
Perm16.left_weak_leq_length
35-
Perm16.left_weak_leq_ref
36-
Perm16.lehmer
37-
Perm16.lehmer_arr
38-
Perm16.lehmer_ref
39-
Perm16.length
40-
Perm16.length_arr
41-
Perm16.length_ref
42-
Perm16.nb_cycles
43-
Perm16.nb_cycles_ref
44-
Perm16.nb_cycles_unroll
45-
Perm16.nb_descents
46-
Perm16.nb_descents_ref
47-
Perm16.one
48-
Perm16.unrankSJT
49-
Perm16.validate
50-
51-
Full API
52-
--------
53-
54-
.. autoclass:: Perm16
55-
:class-doc-from: init
56-
:members:
11+
================
12+
13+
.. ifconfig:: not LIBSEMIGROUPS_HPCOMBI_ENABLED
14+
15+
.. warning::
16+
17+
It appears that the version of ``libsemigroups`` used with
18+
``libsemigroups_pybind11`` was not compiled with ``HPCombi`` enabled
19+
and so none of the functionality of ``HPCombi`` is available.
20+
21+
.. ifconfig:: LIBSEMIGROUPS_HPCOMBI_ENABLED
22+
23+
.. autoclass:: Perm16
24+
:doc-only:
25+
26+
Contents
27+
--------
28+
29+
.. autosummary::
30+
:signatures: short
31+
32+
~Perm16
33+
Perm16.copy
34+
Perm16.cycles_partition
35+
Perm16.elementary_transposition
36+
Perm16.inverse
37+
Perm16.inverse_arr
38+
Perm16.inverse_cycl
39+
Perm16.inverse_find
40+
Perm16.inverse_pow
41+
Perm16.inverse_ref
42+
Perm16.inverse_sort
43+
Perm16.left_weak_leq
44+
Perm16.left_weak_leq_length
45+
Perm16.left_weak_leq_ref
46+
Perm16.lehmer
47+
Perm16.lehmer_arr
48+
Perm16.lehmer_ref
49+
Perm16.length
50+
Perm16.length_arr
51+
Perm16.length_ref
52+
Perm16.nb_cycles
53+
Perm16.nb_cycles_ref
54+
Perm16.nb_cycles_unroll
55+
Perm16.nb_descents
56+
Perm16.nb_descents_ref
57+
Perm16.one
58+
Perm16.unrankSJT
59+
Perm16.validate
60+
61+
Full API
62+
--------
63+
64+
.. autoclass:: Perm16
65+
:class-doc-from: init
66+
:members:

docs/source/data-structures/hpcombi/pperm16.rst

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,28 @@
1010
The PPerm16 class
1111
=================
1212

13-
.. autoclass:: PPerm16
14-
:doc-only:
13+
.. ifconfig LIBSEMIGROUPS_HPCOMBI_ENABLED
1514
16-
Contents
17-
--------
15+
.. autoclass:: PPerm16
16+
:doc-only:
1817
19-
.. autosummary::
20-
:signatures: short
18+
Contents
19+
--------
2120
22-
~PPerm16
23-
PPerm16.copy
24-
PPerm16.inverse_ref
25-
PPerm16.left_one
26-
PPerm16.one
27-
PPerm16.right_one
28-
PPerm16.validate
21+
.. autosummary::
22+
:signatures: short
2923
30-
Full API
31-
--------
24+
~PPerm16
25+
PPerm16.copy
26+
PPerm16.inverse_ref
27+
PPerm16.left_one
28+
PPerm16.one
29+
PPerm16.right_one
30+
PPerm16.validate
3231
33-
.. autoclass:: PPerm16
34-
:class-doc-from: init
35-
:members:
32+
Full API
33+
--------
34+
35+
.. autoclass:: PPerm16
36+
:class-doc-from: init
37+
:members:

docs/source/data-structures/hpcombi/ptransf16.rst

Lines changed: 39 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -10,40 +10,42 @@
1010
The PTransf16 class
1111
===================
1212

13-
.. autoclass:: PTransf16
14-
:doc-only:
15-
16-
Contents
17-
--------
18-
19-
.. autosummary::
20-
:signatures: short
21-
22-
~PTransf16
23-
PTransf16.copy
24-
PTransf16.domain_bitset
25-
PTransf16.domain_mask
26-
PTransf16.fix_points_bitset
27-
PTransf16.fix_points_mask
28-
PTransf16.image_bitset
29-
PTransf16.image_mask
30-
PTransf16.image_mask_ref
31-
PTransf16.largest_fix_point
32-
PTransf16.largest_moved_point
33-
PTransf16.left_one
34-
PTransf16.nb_fix_points
35-
PTransf16.one
36-
PTransf16.rank
37-
PTransf16.rank_cmpestrm
38-
PTransf16.rank_ref
39-
PTransf16.right_one
40-
PTransf16.smallest_fix_point
41-
PTransf16.smallest_moved_point
42-
PTransf16.validate
43-
44-
Full API
45-
--------
46-
47-
.. autoclass:: PTransf16
48-
:class-doc-from: init
49-
:members:
13+
.. ifconfig LIBSEMIGROUPS_HPCOMBI_ENABLED
14+
15+
.. autoclass:: PTransf16
16+
:doc-only:
17+
18+
Contents
19+
--------
20+
21+
.. autosummary::
22+
:signatures: short
23+
24+
~PTransf16
25+
PTransf16.copy
26+
PTransf16.domain_bitset
27+
PTransf16.domain_mask
28+
PTransf16.fix_points_bitset
29+
PTransf16.fix_points_mask
30+
PTransf16.image_bitset
31+
PTransf16.image_mask
32+
PTransf16.image_mask_ref
33+
PTransf16.largest_fix_point
34+
PTransf16.largest_moved_point
35+
PTransf16.left_one
36+
PTransf16.nb_fix_points
37+
PTransf16.one
38+
PTransf16.rank
39+
PTransf16.rank_cmpestrm
40+
PTransf16.rank_ref
41+
PTransf16.right_one
42+
PTransf16.smallest_fix_point
43+
PTransf16.smallest_moved_point
44+
PTransf16.validate
45+
46+
Full API
47+
--------
48+
49+
.. autoclass:: PTransf16
50+
:class-doc-from: init
51+
:members:

docs/source/data-structures/hpcombi/transf16.rst

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,25 @@
1010
The Transf16 class
1111
==================
1212

13-
.. autoclass:: Transf16
14-
:doc-only:
13+
.. ifconfig LIBSEMIGROUPS_HPCOMBI_ENABLED
1514
16-
Contents
17-
--------
15+
.. autoclass:: Transf16
16+
:doc-only:
1817
19-
.. autosummary::
20-
:signatures: short
18+
Contents
19+
--------
2120
22-
~Transf16
23-
Transf16.copy
24-
Transf16.one
25-
Transf16.validate
21+
.. autosummary::
22+
:signatures: short
2623
27-
Full API
28-
--------
24+
~Transf16
25+
Transf16.copy
26+
Transf16.one
27+
Transf16.validate
2928
30-
.. autoclass:: Transf16
31-
:class-doc-from: init
32-
:members:
29+
Full API
30+
--------
31+
32+
.. autoclass:: Transf16
33+
:class-doc-from: init
34+
:members:

docs/source/data-structures/hpcombi/vect16.rst

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,34 @@
1010
The Vect16 class
1111
================
1212

13-
.. autoclass:: Vect16
14-
:doc-only:
15-
16-
Contents
17-
--------
18-
19-
.. autosummary::
20-
:signatures: short
21-
22-
~Vect16
23-
Vect16.copy
24-
Vect16.eval16
25-
Vect16.first_diff
26-
Vect16.first_non_zero
27-
Vect16.first_zero
28-
Vect16.is_permutation
29-
Vect16.last_diff
30-
Vect16.last_non_zero
31-
Vect16.last_zero
32-
Vect16.less_partial
33-
Vect16.partial_sums
34-
Vect16.sum
35-
36-
Full API
37-
--------
38-
39-
.. autoclass:: Vect16
40-
:class-doc-from: init
41-
:members:
13+
.. ifconfig LIBSEMIGROUPS_HPCOMBI_ENABLED
14+
15+
.. autoclass:: Vect16
16+
:doc-only:
17+
18+
Contents
19+
--------
20+
21+
.. autosummary::
22+
:signatures: short
23+
24+
~Vect16
25+
Vect16.copy
26+
Vect16.eval16
27+
Vect16.first_diff
28+
Vect16.first_non_zero
29+
Vect16.first_zero
30+
Vect16.is_permutation
31+
Vect16.last_diff
32+
Vect16.last_non_zero
33+
Vect16.last_zero
34+
Vect16.less_partial
35+
Vect16.partial_sums
36+
Vect16.sum
37+
38+
Full API
39+
--------
40+
41+
.. autoclass:: Vect16
42+
:class-doc-from: init
43+
:members:

0 commit comments

Comments
 (0)