Recent commits to derivepassphrase.git (fe2f7d14ddba40a21bb6ed969cbbc76907ec5f02)

Add hypothesis inventory to documentation

2025-01-24T23:04:28+01:00

Now hypothesis decorators and strategies will be highlighted and linked
in the API documentation.
</pre>

Add docstrings for all test functions and test helper functions

2025-01-24T23:03:43+01:00

These docstrings aim to provide intent and context to the test function.
</pre>

Add some explicit, readable test IDs

2025-01-23T23:41:09+01:00

</pre>

Add tests API documentation to "dev setup" MkDocs build

2025-01-23T11:58:44+01:00

Most API documentation is highly deficient at this point, but exposing
it in this way hopefully makes it more likely I'll get to documenting
the tests.  The hope for the future is that it might be faster to
consult the API documentation than to skim through the test file to see
if and where a certain aspect is being tested, whether the classes are
too large, etc.
</pre>

Modernize MkDocs configuration, move dev stuff to separate configuration

2025-01-23T11:51:49+01:00

The standard (online) and the offline configurations now use the
`draft_docs` option from MkDocs 1.6.

A new "dev setup" configuration, inheriting from the offline
configuration, additionally renders documentation intended as
development aids.  Unfortunately, this requires duplicating the
navigation structure.
</pre>

Merge topic branch 'version-upgrade-todos' into master

2025-01-23T10:54:16+01:00

* t/version-upgrade-todos:
  Convert informal upgrade comments to proper TODOs
  Add links and anchors for version/upgrade information and changelog sections
</pre>

Convert informal upgrade comments to proper TODOs

2025-01-23T10:53:54+01:00

This includes a short instruction and a link to the upgrade notes or
Python compatibility section related to this code section.
</pre>

Add links and anchors for version/upgrade information and changelog sections

2025-01-23T10:53:54+01:00

Add separate documentation pages for Python version information and
`derivepassphrase` upgrade notes.  Apart from the informative aspect, it
also serves as an anchor which all code upgrade tasks and TODOs that
belong to the same upgrade step can link to, and which can then be
grepped for in the code.

Relatedly, give the changelog proper, systematic, non-auto-generated
anchor targets.
</pre>

Merge topic branch 'usage-fixes' into master

2025-01-23T10:52:16+01:00

* t/usage-fixes:
  Move license in docstring to comments
  Refactor some if/elif/else-towers into dispatch tables
  Make the notes instruction text and marker translatable
</pre>

Move license in docstring to comments

2025-01-23T10:51:36+01:00

</pre>