Summary

Add documentation on Cryptozoology.

Review Request #15190 — Created July 23, 2026 and updated July 30, 2026, 5:17 p.m.

Information

Owner

chipx86

Repository

cryptozoology

Branch

master

Bugs

Depends On

Reviewers

Groups

beanbag-misc

People

Description

This adds a docs page for Cryptozoology, which features a brief
overview, a code reference, and release notes.

The documentation is pretty brief, and at this stage does not include
any useful guides or code samples.

A TBD 1.0 release notes page has been written to go along with this, as
well as a README.

Testing Done

Built the docs and checked for obvious issues or build errors.

Viewed the README in a ReST viewer. Checked for build errors and link
issues.

Commits

Summary	ID
Add documentation on Cryptozoology. This adds a docs page for Cryptozoology, which features a brief overview, a code reference, and release notes. The documentation is pretty brief, and at this stage does not include any useful guides or code samples. A TBD 1.0 release notes page has been written to go along with this, as well as a README.	766200b188244675622ff14afb9bf2cdbda64f9e

Issues

Description	From	Last Updated
Copy/pasto: repo link points to typelets, not buildthings	david	July 30, 2026, 5:15 a.m.
module level import not at top of file Column: 1 Error code: E402	reviewbot	July 23, 2026, 3:36 a.m.
module level import not at top of file Column: 1 Error code: E402	reviewbot	July 23, 2026, 3:36 a.m.
This has been deprecated since Sphinx 1.8. Can we migrate? autodoc_default_options = { 'members': True, 'special-members': True, 'undoc-members': True, 'show-inheritance': …	david	July 30, 2026, 5:16 a.m.
Typos: napolean -> napoleon Do we have this mistake elsewhere that you copied from?	david	July 30, 2026, 5:16 a.m.
Your other bullet points have periods at the end.	david	July 30, 2026, 5:16 a.m.
Doesn't the _ need to be inside <ecies_>? Seems like this would treat this as a (broken) reference	david	July 30, 2026, 5:17 a.m.
module level import not at top of file Column: 1 Error code: E402	reviewbot	July 30, 2026, 5:19 a.m.
module level import not at top of file Column: 1 Error code: E402	reviewbot	July 30, 2026, 5:19 a.m.

flake8 failed.

JSHint passed.

flake8

docs/conf.py (Diff revision 1)

The issue has been dropped. Show all issues

module level import not at top of file

Column: 1
Error code: E402

docs/conf.py (Diff revision 1)

The issue has been dropped. Show all issues

module level import not at top of file

Column: 1
Error code: E402

README.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Copy/pasto: repo link points to typelets, not buildthings
```

docs/conf.py (Diff revision 1)

The issue has been resolved. Show all issues

This has been deprecated since Sphinx 1.8. Can we migrate?

autodoc_default_options = {
    'members': True,
    'special-members': True,
    'undoc-members': True,
    'show-inheritance': True,
}

docs/conf.py (Diff revision 1)

The issue has been resolved. Show all issues

Typos: napolean -> napoleon

Do we have this mistake elsewhere that you copied from?

chipx86

July 23, 2026, 9:11 p.m.

Yep. Probably a lot of places. This file was largely copied from registries, which was copied from somewhere else.

docs/index.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Your other bullet points have periods at the end.
```

docs/index.rst (Diff revision 1)

The issue has been resolved. Show all issues

Doesn't the _ need to be inside <ecies_>? Seems like this would treat this as a (broken) reference

Change Summary:


Removed the typoed napolean_* arguments and legacy autodoc_default_options values, which are not needed since just using our autodoc_utils extension sets all this up right.
Fixed several other typoes and inconsistencies.

Commits:

	Summary	ID
	Add documentation on Cryptozoology. This adds a docs page for Cryptozoology, which features a brief overview, a code reference, and release notes. The documentation is pretty brief, and at this stage does not include any useful guides or code samples. A TBD 1.0 release notes page has been written to go along with this, as well as a README.	7d05129a31192807e45cbaeb0e48f85bca09004a
	Add documentation on Cryptozoology. This adds a docs page for Cryptozoology, which features a brief overview, a code reference, and release notes. The documentation is pretty brief, and at this stage does not include any useful guides or code samples. A TBD 1.0 release notes page has been written to go along with this, as well as a README.	766200b188244675622ff14afb9bf2cdbda64f9e

Diff:

Revision 2 (+818)

Show changes

	.gitignore
	.readthedocs.yml
	README.rst
	doc-requirements.txt
	docs/Makefile
	docs/conf.py
	docs/index.rst
	docs/coderef/index.rst
	2 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

docs/conf.py (Diff revision 2)

The issue has been dropped. Show all issues

module level import not at top of file

Column: 1
Error code: E402

docs/conf.py (Diff revision 2)

The issue has been dropped. Show all issues

module level import not at top of file

Column: 1
Error code: E402

Ship it!

```
Ship It!
```