jbms / sphinx-immaterial

Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system
https://jbms.github.io/sphinx-immaterial/
Other
196 stars 29 forks source link

Fix WARNING: unsupported theme option 'analytics' given #165

Closed jan-matejka closed 1 year ago

2bndy5 commented 1 year ago

Typically, people should open an issue for a problem first before submitting an unprompted fix to an unknown problem.

We haven't been seeing this warning in the build logs (the CI would've failed if it showed). Can you give us some info about how to reproduce this warning?

mhostetter commented 1 year ago

@2bndy5 I get this warning every time I build.

https://github.com/mhostetter/galois/blob/e3af9944243b7bdb808c6124471986120a2aafd4/docs/conf.py#L170-L173

checking consistency... done
preparing documents... WARNING: unsupported theme option 'social' given
WARNING: unsupported theme option 'analytics' given
done
Full output ```console $ rm -rf docs/build && rm -rf docs/api && sphinx-build -b dirhtml -v docs/ docs/build/ Running Sphinx v5.1.1 /usr/lib/python3/dist-packages/requests/__init__.py:89: RequestsDependencyWarning: urllib3 (1.26.11) or chardet (3.0.4) doesn't match a supported version! warnings.warn("urllib3 ({}) or chardet ({}) doesn't match a supported " making output directory... done locale_dir /mnt/c/Users/matth/repos/galois/docs/locales/en/LC_MESSAGES does not exists loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv... myst v0.17.2: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=['dollarmath'], linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, highlight_code_blocks=True, number_code_blocks=[], title_to_header=False, heading_anchors=None, heading_slug_func=None, footnote_transition=True, sub_delimiters=('{', '}'), words_per_minute=200) locale_dir /mnt/c/Users/matth/repos/galois/docs/locales/en/LC_MESSAGES does not exists building [mo]: targets for 0 po files that are out of date building [dirhtml]: targets for 43 source files that are out of date updating environment: locale_dir /mnt/c/Users/matth/repos/galois/docs/locales/en/LC_MESSAGES does not exists [new config] 316 added, 0 changed, 0 removed reading sources... [ 0%] api reading sources... [ 0%] api/galois.Array reading sources... [ 0%] api/galois.Array.Identity reading sources... [ 1%] api/galois.Array.Ones reading sources... [ 1%] api/galois.Array.Random reading sources... [ 1%] api/galois.Array.Range reading sources... [ 2%] api/galois.Array.Zeros reading sources... [ 2%] api/galois.Array.characteristic reading sources... [ 2%] api/galois.Array.compile reading sources... [ 3%] api/galois.Array.default_ufunc_mode reading sources... [ 3%] api/galois.Array.degree reading sources... [ 3%] api/galois.Array.display reading sources... [ 4%] api/galois.Array.display_mode reading sources... [ 4%] api/galois.Array.dtypes reading sources... [ 4%] api/galois.Array.elements reading sources... [ 5%] api/galois.Array.irreducible_poly reading sources... [ 5%] api/galois.Array.name reading sources... [ 5%] api/galois.Array.order reading sources... [ 6%] api/galois.Array.primitive_element reading sources... [ 6%] api/galois.Array.ufunc_mode reading sources... [ 6%] api/galois.Array.ufunc_modes reading sources... [ 6%] api/galois.Array.units reading sources... [ 7%] api/galois.BCH reading sources... [ 7%] api/galois.BCH.G reading sources... [ 7%] api/galois.BCH.H reading sources... [ 8%] api/galois.BCH.__init__ reading sources... [ 8%] api/galois.BCH.__repr__ reading sources... [ 8%] api/galois.BCH.__str__ reading sources... [ 9%] api/galois.BCH.alpha reading sources... [ 9%] api/galois.BCH.c reading sources... [ 9%] api/galois.BCH.d reading sources... [ 10%] api/galois.BCH.decode reading sources... [ 10%] api/galois.BCH.detect reading sources... [ 10%] api/galois.BCH.encode reading sources... [ 11%] api/galois.BCH.extension_field reading sources... [ 11%] api/galois.BCH.field reading sources... [ 11%] api/galois.BCH.generator_poly reading sources... [ 12%] api/galois.BCH.is_narrow_sense reading sources... [ 12%] api/galois.BCH.is_primitive reading sources... [ 12%] api/galois.BCH.is_systematic reading sources... [ 12%] api/galois.BCH.k reading sources... [ 13%] api/galois.BCH.n reading sources... [ 13%] api/galois.BCH.parity_check_poly reading sources... [ 13%] api/galois.BCH.roots reading sources... [ 14%] api/galois.BCH.t reading sources... [ 14%] api/galois.CyclicCode reading sources... [ 14%] api/galois.CyclicCode.__init__ reading sources... [ 15%] api/galois.CyclicCode.__repr__ reading sources... [ 15%] api/galois.CyclicCode.__str__ reading sources... [ 15%] api/galois.CyclicCode.decode reading sources... [ 16%] api/galois.CyclicCode.encode reading sources... [ 16%] api/galois.CyclicCode.generator_poly reading sources... [ 16%] api/galois.CyclicCode.parity_check_poly reading sources... [ 17%] api/galois.CyclicCode.roots reading sources... [ 17%] api/galois.FLFSR reading sources... [ 17%] api/galois.FLFSR.Taps reading sources... [ 18%] api/galois.FLFSR.__init__ reading sources... [ 18%] api/galois.FLFSR.__repr__ reading sources... [ 18%] api/galois.FLFSR.__str__ reading sources... [ 18%] api/galois.FLFSR.characteristic_poly reading sources... [ 19%] api/galois.FLFSR.feedback_poly reading sources... [ 19%] api/galois.FLFSR.field reading sources... [ 19%] api/galois.FLFSR.initial_state reading sources... [ 20%] api/galois.FLFSR.order reading sources... [ 20%] api/galois.FLFSR.reset reading sources... [ 20%] api/galois.FLFSR.state reading sources... [ 21%] api/galois.FLFSR.step reading sources... [ 21%] api/galois.FLFSR.taps reading sources... [ 21%] api/galois.FLFSR.to_galois_lfsr reading sources... [ 22%] api/galois.Field reading sources... [ 22%] api/galois.FieldArray reading sources... [ 22%] api/galois.FieldArray.Identity reading sources... [ 23%] api/galois.FieldArray.Ones reading sources... [ 23%] api/galois.FieldArray.Random reading sources... [ 23%] api/galois.FieldArray.Range reading sources... [ 24%] api/galois.FieldArray.Vandermonde reading sources... [ 24%] api/galois.FieldArray.Vector reading sources... [ 24%] api/galois.FieldArray.Zeros reading sources... [ 25%] api/galois.FieldArray.__init__ reading sources... [ 25%] api/galois.FieldArray.__repr__ reading sources... [ 25%] api/galois.FieldArray.__str__ reading sources... [ 25%] api/galois.FieldArray.additive_order reading sources... [ 26%] api/galois.FieldArray.arithmetic_table reading sources... [ 26%] api/galois.FieldArray.characteristic reading sources... [ 26%] api/galois.FieldArray.characteristic_poly reading sources... [ 27%] api/galois.FieldArray.column_space reading sources... [ 27%] api/galois.FieldArray.default_ufunc_mode reading sources... [ 27%] api/galois.FieldArray.degree reading sources... [ 28%] api/galois.FieldArray.display_mode reading sources... [ 28%] api/galois.FieldArray.dtypes reading sources... [ 28%] api/galois.FieldArray.elements reading sources... [ 29%] api/galois.FieldArray.field_norm reading sources... [ 29%] api/galois.FieldArray.field_trace reading sources... [ 29%] api/galois.FieldArray.irreducible_poly reading sources... [ 30%] api/galois.FieldArray.is_extension_field reading sources... [ 30%] api/galois.FieldArray.is_prime_field reading sources... [ 30%] api/galois.FieldArray.is_primitive_poly reading sources... [ 31%] api/galois.FieldArray.is_square reading sources... [ 31%] api/galois.FieldArray.left_null_space reading sources... [ 31%] api/galois.FieldArray.log reading sources... [ 31%] api/galois.FieldArray.lu_decompose reading sources... [ 32%] api/galois.FieldArray.minimal_poly reading sources... [ 32%] api/galois.FieldArray.multiplicative_order reading sources... [ 32%] api/galois.FieldArray.name reading sources... [ 33%] api/galois.FieldArray.non_squares reading sources... [ 33%] api/galois.FieldArray.null_space reading sources... [ 33%] api/galois.FieldArray.order reading sources... [ 34%] api/galois.FieldArray.plu_decompose reading sources... [ 34%] api/galois.FieldArray.prime_subfield reading sources... [ 34%] api/galois.FieldArray.primitive_element reading sources... [ 35%] api/galois.FieldArray.primitive_elements reading sources... [ 35%] api/galois.FieldArray.primitive_root_of_unity reading sources... [ 35%] api/galois.FieldArray.primitive_roots_of_unity reading sources... [ 36%] api/galois.FieldArray.properties reading sources... [ 36%] api/galois.FieldArray.repr_table reading sources... [ 36%] api/galois.FieldArray.row_reduce reading sources... [ 37%] api/galois.FieldArray.row_space reading sources... [ 37%] api/galois.FieldArray.squares reading sources... [ 37%] api/galois.FieldArray.ufunc_mode reading sources... [ 37%] api/galois.FieldArray.ufunc_modes reading sources... [ 38%] api/galois.FieldArray.units reading sources... [ 38%] api/galois.FieldArray.vector reading sources... [ 38%] api/galois.GF reading sources... [ 39%] api/galois.GF2 reading sources... [ 39%] api/galois.GLFSR reading sources... [ 39%] api/galois.GLFSR.Taps reading sources... [ 40%] api/galois.GLFSR.__init__ reading sources... [ 40%] api/galois.GLFSR.__repr__ reading sources... [ 40%] api/galois.GLFSR.__str__ reading sources... [ 41%] api/galois.GLFSR.characteristic_poly reading sources... [ 41%] api/galois.GLFSR.feedback_poly reading sources... [ 41%] api/galois.GLFSR.field reading sources... [ 42%] api/galois.GLFSR.initial_state reading sources... [ 42%] api/galois.GLFSR.order reading sources... [ 42%] api/galois.GLFSR.reset reading sources... [ 43%] api/galois.GLFSR.state reading sources... [ 43%] api/galois.GLFSR.step reading sources... [ 43%] api/galois.GLFSR.taps reading sources... [ 43%] api/galois.GLFSR.to_fibonacci_lfsr reading sources... [ 44%] api/galois.LinearCode reading sources... [ 44%] api/galois.LinearCode.G reading sources... [ 44%] api/galois.LinearCode.H reading sources... [ 45%] api/galois.LinearCode.__init__ reading sources... [ 45%] api/galois.LinearCode.__repr__ reading sources... [ 45%] api/galois.LinearCode.__str__ reading sources... [ 46%] api/galois.LinearCode.d reading sources... [ 46%] api/galois.LinearCode.decode reading sources... [ 46%] api/galois.LinearCode.detect reading sources... [ 47%] api/galois.LinearCode.encode reading sources... [ 47%] api/galois.LinearCode.field reading sources... [ 47%] api/galois.LinearCode.is_systematic reading sources... [ 48%] api/galois.LinearCode.k reading sources... [ 48%] api/galois.LinearCode.n reading sources... [ 48%] api/galois.LinearCode.t reading sources... [ 49%] api/galois.Poly reading sources... [ 49%] api/galois.Poly.Degrees reading sources... [ 49%] api/galois.Poly.Identity reading sources... [ 50%] api/galois.Poly.Int reading sources... [ 50%] api/galois.Poly.One reading sources... [ 50%] api/galois.Poly.Random reading sources... [ 50%] api/galois.Poly.Roots reading sources... [ 51%] api/galois.Poly.Str reading sources... [ 51%] api/galois.Poly.Zero reading sources... [ 51%] api/galois.Poly.__call__ reading sources... [ 52%] api/galois.Poly.__eq__ reading sources... [ 52%] api/galois.Poly.__init__ reading sources... [ 52%] api/galois.Poly.__int__ reading sources... [ 53%] api/galois.Poly.__len__ reading sources... [ 53%] api/galois.Poly.__repr__ reading sources... [ 53%] api/galois.Poly.__str__ reading sources... [ 54%] api/galois.Poly.coefficients reading sources... [ 54%] api/galois.Poly.coeffs reading sources... [ 54%] api/galois.Poly.degree reading sources... [ 55%] api/galois.Poly.degrees reading sources... [ 55%] api/galois.Poly.derivative reading sources... [ 55%] api/galois.Poly.distinct_degree_factors reading sources... [ 56%] api/galois.Poly.equal_degree_factors reading sources... [ 56%] api/galois.Poly.factors reading sources... [ 56%] api/galois.Poly.field reading sources... [ 56%] api/galois.Poly.is_irreducible reading sources... [ 57%] api/galois.Poly.is_monic reading sources... [ 57%] api/galois.Poly.is_primitive reading sources... [ 57%] api/galois.Poly.is_square_free reading sources... [ 58%] api/galois.Poly.nonzero_coeffs reading sources... [ 58%] api/galois.Poly.nonzero_degrees reading sources... [ 58%] api/galois.Poly.reverse reading sources... [ 59%] api/galois.Poly.roots reading sources... [ 59%] api/galois.Poly.square_free_factors reading sources... [ 59%] api/galois.ReedSolomon reading sources... [ 60%] api/galois.ReedSolomon.G reading sources... [ 60%] api/galois.ReedSolomon.H reading sources... [ 60%] api/galois.ReedSolomon.__init__ reading sources... [ 61%] api/galois.ReedSolomon.__repr__ reading sources... [ 61%] api/galois.ReedSolomon.__str__ reading sources... [ 61%] api/galois.ReedSolomon.alpha reading sources... [ 62%] api/galois.ReedSolomon.c reading sources... [ 62%] api/galois.ReedSolomon.d reading sources... [ 62%] api/galois.ReedSolomon.decode reading sources... [ 62%] api/galois.ReedSolomon.detect reading sources... [ 63%] api/galois.ReedSolomon.encode reading sources... [ 63%] api/galois.ReedSolomon.field reading sources... [ 63%] api/galois.ReedSolomon.generator_poly reading sources... [ 64%] api/galois.ReedSolomon.is_narrow_sense reading sources... [ 64%] api/galois.ReedSolomon.is_primitive reading sources... [ 64%] api/galois.ReedSolomon.is_systematic reading sources... [ 65%] api/galois.ReedSolomon.k reading sources... [ 65%] api/galois.ReedSolomon.n reading sources... [ 65%] api/galois.ReedSolomon.parity_check_poly reading sources... [ 66%] api/galois.ReedSolomon.roots reading sources... [ 66%] api/galois.ReedSolomon.t reading sources... [ 66%] api/galois.are_coprime reading sources... [ 67%] api/galois.berlekamp_massey reading sources... [ 67%] api/galois.carmichael_lambda reading sources... [ 67%] api/galois.conway_poly reading sources... [ 68%] api/galois.crt reading sources... [ 68%] api/galois.divisor_sigma reading sources... [ 68%] api/galois.divisors reading sources... [ 68%] api/galois.egcd reading sources... [ 69%] api/galois.euler_phi reading sources... [ 69%] api/galois.factors reading sources... [ 69%] api/galois.fermat_primality_test reading sources... [ 70%] api/galois.gcd reading sources... [ 70%] api/galois.get_printoptions reading sources... [ 70%] api/galois.ilog reading sources... [ 71%] api/galois.intt reading sources... [ 71%] api/galois.iroot reading sources... [ 71%] api/galois.irreducible_poly reading sources... [ 72%] api/galois.irreducible_polys reading sources... [ 72%] api/galois.is_composite reading sources... [ 72%] api/galois.is_cyclic reading sources... [ 73%] api/galois.is_perfect_power reading sources... [ 73%] api/galois.is_powersmooth reading sources... [ 73%] api/galois.is_prime reading sources... [ 74%] api/galois.is_prime_power reading sources... [ 74%] api/galois.is_primitive_element reading sources... [ 74%] api/galois.is_primitive_root reading sources... [ 75%] api/galois.is_smooth reading sources... [ 75%] api/galois.is_square_free reading sources... [ 75%] api/galois.isqrt reading sources... [ 75%] api/galois.jacobi_symbol reading sources... [ 76%] api/galois.kronecker_symbol reading sources... [ 76%] api/galois.kth_prime reading sources... [ 76%] api/galois.lagrange_poly reading sources... [ 77%] api/galois.lcm reading sources... [ 77%] api/galois.legendre_symbol reading sources... [ 77%] api/galois.matlab_primitive_poly reading sources... [ 78%] api/galois.mersenne_exponents reading sources... [ 78%] api/galois.mersenne_primes reading sources... [ 78%] api/galois.miller_rabin_primality_test reading sources... [ 79%] api/galois.next_prime reading sources... [ 79%] api/galois.ntt reading sources... [ 79%] api/galois.perfect_power reading sources... [ 80%] api/galois.pollard_p1 reading sources... [ 80%] api/galois.pollard_rho reading sources... [ 80%] api/galois.prev_prime reading sources... [ 81%] api/galois.primes reading sources... [ 81%] api/galois.primitive_element reading sources... [ 81%] api/galois.primitive_elements reading sources... [ 81%] api/galois.primitive_poly reading sources... [ 82%] api/galois.primitive_polys reading sources... [ 82%] api/galois.primitive_root reading sources... [ 82%] api/galois.primitive_roots reading sources... [ 83%] api/galois.printoptions reading sources... [ 83%] api/galois.prod reading sources... [ 83%] api/galois.random_prime reading sources... [ 84%] api/galois.set_printoptions reading sources... [ 84%] api/galois.totatives reading sources... [ 84%] api/galois.trial_division reading sources... [ 85%] api/galois.typing.ArrayLike reading sources... [ 85%] api/galois.typing.DTypeLike reading sources... [ 85%] api/galois.typing.ElementLike reading sources... [ 86%] api/galois.typing.IterableLike reading sources... [ 86%] api/galois.typing.PolyLike reading sources... [ 86%] api/galois.typing.ShapeLike reading sources... [ 87%] basic-usage/array-arithmetic reading sources... [ 87%] basic-usage/array-classes reading sources... [ 87%] basic-usage/array-creation reading sources... [ 87%] basic-usage/compilation-modes reading sources... [ 88%] basic-usage/element-representation reading sources... [ 88%] basic-usage/poly reading sources... [ 88%] basic-usage/poly-arithmetic reading sources... [ 89%] development/documentation reading sources... [ 89%] development/installation reading sources... [ 89%] development/linter reading sources... [ 90%] development/unit-tests reading sources... [ 90%] genindex reading sources... [ 90%] getting-started reading sources... [ 91%] index reading sources... [ 91%] performance/benchmarks reading sources... [ 91%] performance/binary-extension-fields reading sources... [ 92%] performance/prime-fields reading sources... [ 92%] release-notes/v0.0.14 reading sources... [ 92%] release-notes/v0.0.15 reading sources... [ 93%] release-notes/v0.0.16 reading sources... [ 93%] release-notes/v0.0.17 reading sources... [ 93%] release-notes/v0.0.18 reading sources... [ 93%] release-notes/v0.0.19 reading sources... [ 94%] release-notes/v0.0.20 reading sources... [ 94%] release-notes/v0.0.21 reading sources... [ 94%] release-notes/v0.0.22 reading sources... [ 95%] release-notes/v0.0.23 reading sources... [ 95%] release-notes/v0.0.24 reading sources... [ 95%] release-notes/v0.0.25 reading sources... [ 96%] release-notes/v0.0.26 reading sources... [ 96%] release-notes/v0.0.27 reading sources... [ 96%] release-notes/v0.0.28 reading sources... [ 97%] release-notes/v0.0.29 reading sources... [ 97%] release-notes/v0.0.30 reading sources... [ 97%] release-notes/v0.0.31 reading sources... [ 98%] release-notes/v0.0.32 reading sources... [ 98%] release-notes/v0.0.33 reading sources... [ 98%] release-notes/v0.1.0 reading sources... [ 99%] release-notes/v0.1.1 reading sources... [ 99%] release-notes/versioning reading sources... [ 99%] tutorials/intro-to-extension-fields reading sources... [100%] tutorials/intro-to-prime-fields /mnt/c/Users/matth/repos/galois/docs/api.rst: WARNING: default role python not found /mnt/c/Users/matth/repos/galois/:2: WARNING: Parameter name '*values' does not match any of the parameters defined in the signature: ['values'] /mnt/c/Users/matth/repos/galois/:2: WARNING: Parameter name '*values' does not match any of the parameters defined in the signature: ['values'] /mnt/c/Users/matth/repos/galois/:2: WARNING: Parameter name '*values' does not match any of the parameters defined in the signature: ['values'] looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... WARNING: unsupported theme option 'social' given WARNING: unsupported theme option 'analytics' given done writing output... [ 0%] api writing output... [ 0%] api/galois.Array writing output... [ 0%] api/galois.Array.Identity writing output... [ 1%] api/galois.Array.Ones writing output... [ 1%] api/galois.Array.Random writing output... [ 1%] api/galois.Array.Range writing output... [ 2%] api/galois.Array.Zeros writing output... [ 2%] api/galois.Array.characteristic writing output... [ 2%] api/galois.Array.compile writing output... [ 3%] api/galois.Array.default_ufunc_mode writing output... [ 3%] api/galois.Array.degree writing output... [ 3%] api/galois.Array.display writing output... [ 4%] api/galois.Array.display_mode writing output... [ 4%] api/galois.Array.dtypes writing output... [ 4%] api/galois.Array.elements writing output... [ 5%] api/galois.Array.irreducible_poly writing output... [ 5%] api/galois.Array.name writing output... [ 5%] api/galois.Array.order writing output... [ 6%] api/galois.Array.primitive_element writing output... [ 6%] api/galois.Array.ufunc_mode writing output... [ 6%] api/galois.Array.ufunc_modes writing output... [ 6%] api/galois.Array.units writing output... [ 7%] api/galois.BCH writing output... [ 7%] api/galois.BCH.G writing output... [ 7%] api/galois.BCH.H writing output... [ 8%] api/galois.BCH.__init__ writing output... [ 8%] api/galois.BCH.__repr__ writing output... [ 8%] api/galois.BCH.__str__ writing output... [ 9%] api/galois.BCH.alpha writing output... [ 9%] api/galois.BCH.c writing output... [ 9%] api/galois.BCH.d writing output... [ 10%] api/galois.BCH.decode writing output... [ 10%] api/galois.BCH.detect writing output... [ 10%] api/galois.BCH.encode writing output... [ 11%] api/galois.BCH.extension_field writing output... [ 11%] api/galois.BCH.field writing output... [ 11%] api/galois.BCH.generator_poly writing output... [ 12%] api/galois.BCH.is_narrow_sense writing output... [ 12%] api/galois.BCH.is_primitive writing output... [ 12%] api/galois.BCH.is_systematic writing output... [ 12%] api/galois.BCH.k writing output... [ 13%] api/galois.BCH.n writing output... [ 13%] api/galois.BCH.parity_check_poly writing output... [ 13%] api/galois.BCH.roots writing output... [ 14%] api/galois.BCH.t writing output... [ 14%] api/galois.CyclicCode writing output... [ 14%] api/galois.CyclicCode.__init__ writing output... [ 15%] api/galois.CyclicCode.__repr__ writing output... [ 15%] api/galois.CyclicCode.__str__ writing output... [ 15%] api/galois.CyclicCode.decode writing output... [ 16%] api/galois.CyclicCode.encode writing output... [ 16%] api/galois.CyclicCode.generator_poly writing output... [ 16%] api/galois.CyclicCode.parity_check_poly writing output... [ 17%] api/galois.CyclicCode.roots writing output... [ 17%] api/galois.FLFSR writing output... [ 17%] api/galois.FLFSR.Taps writing output... [ 18%] api/galois.FLFSR.__init__ writing output... [ 18%] api/galois.FLFSR.__repr__ writing output... [ 18%] api/galois.FLFSR.__str__ writing output... [ 18%] api/galois.FLFSR.characteristic_poly writing output... [ 19%] api/galois.FLFSR.feedback_poly writing output... [ 19%] api/galois.FLFSR.field writing output... [ 19%] api/galois.FLFSR.initial_state writing output... [ 20%] api/galois.FLFSR.order writing output... [ 20%] api/galois.FLFSR.reset writing output... [ 20%] api/galois.FLFSR.state writing output... [ 21%] api/galois.FLFSR.step writing output... [ 21%] api/galois.FLFSR.taps writing output... [ 21%] api/galois.FLFSR.to_galois_lfsr writing output... [ 22%] api/galois.Field writing output... [ 22%] api/galois.FieldArray writing output... [ 22%] api/galois.FieldArray.Identity writing output... [ 23%] api/galois.FieldArray.Ones writing output... [ 23%] api/galois.FieldArray.Random writing output... [ 23%] api/galois.FieldArray.Range writing output... [ 24%] api/galois.FieldArray.Vandermonde writing output... [ 24%] api/galois.FieldArray.Vector writing output... [ 24%] api/galois.FieldArray.Zeros writing output... [ 25%] api/galois.FieldArray.__init__ writing output... [ 25%] api/galois.FieldArray.__repr__ writing output... [ 25%] api/galois.FieldArray.__str__ writing output... [ 25%] api/galois.FieldArray.additive_order writing output... [ 26%] api/galois.FieldArray.arithmetic_table writing output... [ 26%] api/galois.FieldArray.characteristic writing output... [ 26%] api/galois.FieldArray.characteristic_poly writing output... [ 27%] api/galois.FieldArray.column_space writing output... [ 27%] api/galois.FieldArray.default_ufunc_mode writing output... [ 27%] api/galois.FieldArray.degree writing output... [ 28%] api/galois.FieldArray.display_mode writing output... [ 28%] api/galois.FieldArray.dtypes writing output... [ 28%] api/galois.FieldArray.elements writing output... [ 29%] api/galois.FieldArray.field_norm writing output... [ 29%] api/galois.FieldArray.field_trace writing output... [ 29%] api/galois.FieldArray.irreducible_poly writing output... [ 30%] api/galois.FieldArray.is_extension_field writing output... [ 30%] api/galois.FieldArray.is_prime_field writing output... [ 30%] api/galois.FieldArray.is_primitive_poly writing output... [ 31%] api/galois.FieldArray.is_square writing output... [ 31%] api/galois.FieldArray.left_null_space writing output... [ 31%] api/galois.FieldArray.log writing output... [ 31%] api/galois.FieldArray.lu_decompose writing output... [ 32%] api/galois.FieldArray.minimal_poly writing output... [ 32%] api/galois.FieldArray.multiplicative_order writing output... [ 32%] api/galois.FieldArray.name writing output... [ 33%] api/galois.FieldArray.non_squares writing output... [ 33%] api/galois.FieldArray.null_space writing output... [ 33%] api/galois.FieldArray.order writing output... [ 34%] api/galois.FieldArray.plu_decompose writing output... [ 34%] api/galois.FieldArray.prime_subfield writing output... [ 34%] api/galois.FieldArray.primitive_element writing output... [ 35%] api/galois.FieldArray.primitive_elements writing output... [ 35%] api/galois.FieldArray.primitive_root_of_unity writing output... [ 35%] api/galois.FieldArray.primitive_roots_of_unity writing output... [ 36%] api/galois.FieldArray.properties writing output... [ 36%] api/galois.FieldArray.repr_table writing output... [ 36%] api/galois.FieldArray.row_reduce writing output... [ 37%] api/galois.FieldArray.row_space writing output... [ 37%] api/galois.FieldArray.squares writing output... [ 37%] api/galois.FieldArray.ufunc_mode writing output... [ 37%] api/galois.FieldArray.ufunc_modes writing output... [ 38%] api/galois.FieldArray.units writing output... [ 38%] api/galois.FieldArray.vector writing output... [ 38%] api/galois.GF writing output... [ 39%] api/galois.GF2 writing output... [ 39%] api/galois.GLFSR writing output... [ 39%] api/galois.GLFSR.Taps writing output... [ 40%] api/galois.GLFSR.__init__ writing output... [ 40%] api/galois.GLFSR.__repr__ writing output... [ 40%] api/galois.GLFSR.__str__ writing output... [ 41%] api/galois.GLFSR.characteristic_poly writing output... [ 41%] api/galois.GLFSR.feedback_poly writing output... [ 41%] api/galois.GLFSR.field writing output... [ 42%] api/galois.GLFSR.initial_state writing output... [ 42%] api/galois.GLFSR.order writing output... [ 42%] api/galois.GLFSR.reset writing output... [ 43%] api/galois.GLFSR.state writing output... [ 43%] api/galois.GLFSR.step writing output... [ 43%] api/galois.GLFSR.taps writing output... [ 43%] api/galois.GLFSR.to_fibonacci_lfsr writing output... [ 44%] api/galois.LinearCode writing output... [ 44%] api/galois.LinearCode.G writing output... [ 44%] api/galois.LinearCode.H writing output... [ 45%] api/galois.LinearCode.__init__ writing output... [ 45%] api/galois.LinearCode.__repr__ writing output... [ 45%] api/galois.LinearCode.__str__ writing output... [ 46%] api/galois.LinearCode.d writing output... [ 46%] api/galois.LinearCode.decode writing output... [ 46%] api/galois.LinearCode.detect writing output... [ 47%] api/galois.LinearCode.encode writing output... [ 47%] api/galois.LinearCode.field writing output... [ 47%] api/galois.LinearCode.is_systematic writing output... [ 48%] api/galois.LinearCode.k writing output... [ 48%] api/galois.LinearCode.n writing output... [ 48%] api/galois.LinearCode.t writing output... [ 49%] api/galois.Poly writing output... [ 49%] api/galois.Poly.Degrees writing output... [ 49%] api/galois.Poly.Identity writing output... [ 50%] api/galois.Poly.Int writing output... [ 50%] api/galois.Poly.One writing output... [ 50%] api/galois.Poly.Random writing output... [ 50%] api/galois.Poly.Roots writing output... [ 51%] api/galois.Poly.Str writing output... [ 51%] api/galois.Poly.Zero writing output... [ 51%] api/galois.Poly.__call__ writing output... [ 52%] api/galois.Poly.__eq__ writing output... [ 52%] api/galois.Poly.__init__ writing output... [ 52%] api/galois.Poly.__int__ writing output... [ 53%] api/galois.Poly.__len__ writing output... [ 53%] api/galois.Poly.__repr__ writing output... [ 53%] api/galois.Poly.__str__ writing output... [ 54%] api/galois.Poly.coefficients writing output... [ 54%] api/galois.Poly.coeffs writing output... [ 54%] api/galois.Poly.degree writing output... [ 55%] api/galois.Poly.degrees writing output... [ 55%] api/galois.Poly.derivative writing output... [ 55%] api/galois.Poly.distinct_degree_factors writing output... [ 56%] api/galois.Poly.equal_degree_factors writing output... [ 56%] api/galois.Poly.factors writing output... [ 56%] api/galois.Poly.field writing output... [ 56%] api/galois.Poly.is_irreducible writing output... [ 57%] api/galois.Poly.is_monic writing output... [ 57%] api/galois.Poly.is_primitive writing output... [ 57%] api/galois.Poly.is_square_free writing output... [ 58%] api/galois.Poly.nonzero_coeffs writing output... [ 58%] api/galois.Poly.nonzero_degrees writing output... [ 58%] api/galois.Poly.reverse writing output... [ 59%] api/galois.Poly.roots writing output... [ 59%] api/galois.Poly.square_free_factors writing output... [ 59%] api/galois.ReedSolomon writing output... [ 60%] api/galois.ReedSolomon.G writing output... [ 60%] api/galois.ReedSolomon.H writing output... [ 60%] api/galois.ReedSolomon.__init__ writing output... [ 61%] api/galois.ReedSolomon.__repr__ writing output... [ 61%] api/galois.ReedSolomon.__str__ writing output... [ 61%] api/galois.ReedSolomon.alpha writing output... [ 62%] api/galois.ReedSolomon.c writing output... [ 62%] api/galois.ReedSolomon.d writing output... [ 62%] api/galois.ReedSolomon.decode writing output... [ 62%] api/galois.ReedSolomon.detect writing output... [ 63%] api/galois.ReedSolomon.encode writing output... [ 63%] api/galois.ReedSolomon.field writing output... [ 63%] api/galois.ReedSolomon.generator_poly writing output... [ 64%] api/galois.ReedSolomon.is_narrow_sense writing output... [ 64%] api/galois.ReedSolomon.is_primitive writing output... [ 64%] api/galois.ReedSolomon.is_systematic writing output... [ 65%] api/galois.ReedSolomon.k writing output... [ 65%] api/galois.ReedSolomon.n writing output... [ 65%] api/galois.ReedSolomon.parity_check_poly writing output... [ 66%] api/galois.ReedSolomon.roots writing output... [ 66%] api/galois.ReedSolomon.t writing output... [ 66%] api/galois.are_coprime writing output... [ 67%] api/galois.berlekamp_massey writing output... [ 67%] api/galois.carmichael_lambda writing output... [ 67%] api/galois.conway_poly writing output... [ 68%] api/galois.crt writing output... [ 68%] api/galois.divisor_sigma writing output... [ 68%] api/galois.divisors writing output... [ 68%] api/galois.egcd writing output... [ 69%] api/galois.euler_phi writing output... [ 69%] api/galois.factors writing output... [ 69%] api/galois.fermat_primality_test writing output... [ 70%] api/galois.gcd writing output... [ 70%] api/galois.get_printoptions writing output... [ 70%] api/galois.ilog writing output... [ 71%] api/galois.intt writing output... [ 71%] api/galois.iroot writing output... [ 71%] api/galois.irreducible_poly writing output... [ 72%] api/galois.irreducible_polys writing output... [ 72%] api/galois.is_composite writing output... [ 72%] api/galois.is_cyclic writing output... [ 73%] api/galois.is_perfect_power writing output... [ 73%] api/galois.is_powersmooth writing output... [ 73%] api/galois.is_prime writing output... [ 74%] api/galois.is_prime_power writing output... [ 74%] api/galois.is_primitive_element writing output... [ 74%] api/galois.is_primitive_root writing output... [ 75%] api/galois.is_smooth writing output... [ 75%] api/galois.is_square_free writing output... [ 75%] api/galois.isqrt writing output... [ 75%] api/galois.jacobi_symbol writing output... [ 76%] api/galois.kronecker_symbol writing output... [ 76%] api/galois.kth_prime writing output... [ 76%] api/galois.lagrange_poly writing output... [ 77%] api/galois.lcm writing output... [ 77%] api/galois.legendre_symbol writing output... [ 77%] api/galois.matlab_primitive_poly writing output... [ 78%] api/galois.mersenne_exponents writing output... [ 78%] api/galois.mersenne_primes writing output... [ 78%] api/galois.miller_rabin_primality_test writing output... [ 79%] api/galois.next_prime writing output... [ 79%] api/galois.ntt writing output... [ 79%] api/galois.perfect_power writing output... [ 80%] api/galois.pollard_p1 writing output... [ 80%] api/galois.pollard_rho writing output... [ 80%] api/galois.prev_prime writing output... [ 81%] api/galois.primes writing output... [ 81%] api/galois.primitive_element writing output... [ 81%] api/galois.primitive_elements writing output... [ 81%] api/galois.primitive_poly writing output... [ 82%] api/galois.primitive_polys writing output... [ 82%] api/galois.primitive_root writing output... [ 82%] api/galois.primitive_roots writing output... [ 83%] api/galois.printoptions writing output... [ 83%] api/galois.prod writing output... [ 83%] api/galois.random_prime writing output... [ 84%] api/galois.set_printoptions writing output... [ 84%] api/galois.totatives writing output... [ 84%] api/galois.trial_division writing output... [ 85%] api/galois.typing.ArrayLike writing output... [ 85%] api/galois.typing.DTypeLike writing output... [ 85%] api/galois.typing.ElementLike writing output... [ 86%] api/galois.typing.IterableLike writing output... [ 86%] api/galois.typing.PolyLike writing output... [ 86%] api/galois.typing.ShapeLike writing output... [ 87%] basic-usage/array-arithmetic writing output... [ 87%] basic-usage/array-classes writing output... [ 87%] basic-usage/array-creation writing output... [ 87%] basic-usage/compilation-modes writing output... [ 88%] basic-usage/element-representation writing output... [ 88%] basic-usage/poly writing output... [ 88%] basic-usage/poly-arithmetic writing output... [ 89%] development/documentation writing output... [ 89%] development/installation writing output... [ 89%] development/linter writing output... [ 90%] development/unit-tests writing output... [ 90%] genindex writing output... [ 90%] getting-started writing output... [ 91%] index writing output... [ 91%] performance/benchmarks writing output... [ 91%] performance/binary-extension-fields writing output... [ 92%] performance/prime-fields writing output... [ 92%] release-notes/v0.0.14 writing output... [ 92%] release-notes/v0.0.15 writing output... [ 93%] release-notes/v0.0.16 writing output... [ 93%] release-notes/v0.0.17 writing output... [ 93%] release-notes/v0.0.18 writing output... [ 93%] release-notes/v0.0.19 writing output... [ 94%] release-notes/v0.0.20 writing output... [ 94%] release-notes/v0.0.21 writing output... [ 94%] release-notes/v0.0.22 writing output... [ 95%] release-notes/v0.0.23 writing output... [ 95%] release-notes/v0.0.24 writing output... [ 95%] release-notes/v0.0.25 writing output... [ 96%] release-notes/v0.0.26 writing output... [ 96%] release-notes/v0.0.27 writing output... [ 96%] release-notes/v0.0.28 writing output... [ 97%] release-notes/v0.0.29 writing output... [ 97%] release-notes/v0.0.30 writing output... [ 97%] release-notes/v0.0.31 writing output... [ 98%] release-notes/v0.0.32 writing output... [ 98%] release-notes/v0.0.33 writing output... [ 98%] release-notes/v0.1.0 writing output... [ 99%] release-notes/v0.1.1 writing output... [ 99%] release-notes/versioning writing output... [ 99%] tutorials/intro-to-extension-fields writing output... [100%] tutorials/intro-to-prime-fields generating indices... genindex py-modindex done writing additional pages... done copying images... [100%] ../logo/galois-heading.png copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done Generating sitemap for 318 pages in /mnt/c/Users/matth/repos/galois/docs/build/sitemap.xml build succeeded, 6 warnings. The HTML pages are in docs/build. ```

I also get a warning about social.

https://github.com/mhostetter/galois/blob/e3af9944243b7bdb808c6124471986120a2aafd4/docs/conf.py#L122-L135

2bndy5 commented 1 year ago

Oh cool, the social icons work! This should definitely be added to the customization.rst (& theme.conf)

As far as the analytics option, I think this was missed in #57

2bndy5 commented 1 year ago

Damn! I think mypy just released another breaking change...

mhostetter commented 1 year ago

As far as the analytics option, I think this was missed in https://github.com/jbms/sphinx-immaterial/pull/57

Yeah, I missed it in that PR. I've since noticed the warnings, and even tried to find where to define the theme option (but to no avail). I didn't open an issue previously because I feel I'm already too annoying with my issues here. 😜

2bndy5 commented 1 year ago

TBH, any kind of feedback can serve as a "pulse check" for a project.

I'm working up a test module that should be consistent with what the docs say. I'm not sure if it is worth it though...

I fixed the typing problems in the CI and submitted #166. Hopefully, after that is merged we can merge this without conflict. @jbms I'm ok with merging this as is because there's nothing here that would cause mypy to fail.

jbms commented 1 year ago

Thanks!

2bndy5 commented 1 year ago

The fix for this was released in v0.9.1