Skip to content

docs: improve two-factor authentication documentation outline - #15510

Merged
reaperhulk merged 1 commit into
pyca:mainfrom
wbolster:docs-2fa
Aug 24, 2026
Merged

docs: improve two-factor authentication documentation outline#15510
reaperhulk merged 1 commit into
pyca:mainfrom
wbolster:docs-2fa

Conversation

@wbolster

Copy link
Copy Markdown
Contributor

This improves the document structure for the HOTP and TOTP docs. Both now have a heading at the same level, so that both appear in the navigation sidebar.

Before this change, HOTP had an autogenerated heading, while TOTP was incorrectly hidden as a subsection of the HOTP section, due to Sphinx automatically adding sub-headings for :class: blocks.

Also lift the section about the provisioning URI to a sibling level, since it applies equally to HOTP and TOTP.

This improves the document structure for the HOTP and TOTP docs.
Both now have a heading at the same level, so that both appear in the
navigation sidebar.

Before this change, HOTP had an autogenerated heading, while TOTP was
incorrectly hidden as a subsection of the HOTP section, due to Sphinx
automatically adding sub-headings for :class: blocks.

Also lift the section about the provisioning URI to a sibling level,
since it applies equally to HOTP and TOTP.
@reaperhulk
reaperhulk enabled auto-merge (squash) August 24, 2026 11:33
@wbolster

wbolster commented Aug 24, 2026

Copy link
Copy Markdown
Contributor Author

for easier review, fully expanded outline before (incorrect):

Two-factor authentication
- InvalidToken
- HOTPHashTypes
- HOTP (class)
- Throttling
- Re-synchronization of the counter
  - TOTP (class)
- Provisioning URI

… and after (improved):

Two-factor authentication
- InvalidToken
- HOTP
  - HOTPHashTypes
  - HOTP (class)
  - Throttling
  - Re-synchronization of the counter
- TOTP
  - TOTP (class)
- Provisioning URI

@reaperhulk
reaperhulk merged commit 9d19445 into pyca:main Aug 24, 2026
68 checks passed
@wbolster
wbolster deleted the docs-2fa branch August 24, 2026 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants