Commit graph

537 commits

Author SHA1 Message Date
David Runge
02c7b04cfd
Adapt Containerfile to build with a patched version of sphinx
Sphinx >= 7.1.0 has issues rendering EPUBs correctly.
Install latest sphinx and apply a patch to fix EPUB rendering.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-24 13:21:55 +01:00
David Runge
eeb1de8ab7
Add woodpecker integration for building and testing the EPUB
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-24 13:21:52 +01:00
David Runge
ccddbe4204
Add local copy of upstreamed sphinx patch for CSS issues with EPUBs
The patch fixes https://github.com/sphinx-doc/sphinx/issues/11598
for sphinx >= 7.2.0

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-24 13:19:20 +01:00
David Runge
57f62222d2
Add reuse config for patches
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-24 13:19:19 +01:00
David Runge
8f1d939ddb
Add make target to check a cleanly built EPUB using epubcheck
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-24 13:19:17 +01:00
David Runge
d7d34d4940
Move MyST-parser configuration to its own section
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-24 13:19:17 +01:00
David Runge
34f94f7802
Move numfig configuration to general configuration
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-24 13:19:16 +01:00
David Runge
ec761273df
Modify CSS for admonition environments when building EPUB
Add a lightgray `background-color` for all admonition environments.
Add a palevioletred `background-color` for all admonition-warning and
warning environments.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-24 13:19:11 +01:00
Heiko Schaefer
4e9f1c0ffd
add note to "differences between versions" chapter 2023-11-23 13:19:48 +01:00
Heiko Schaefer
a3cff899be
move chapters 17+ one back, insert a new "differences between versions" chapter 17 2023-11-23 12:48:18 +01:00
Heiko Schaefer
886e8f5ff2
Add anchor, and clarify intended meaning of section 2023-11-22 15:06:20 +01:00
heiko
17d4894ee7 Merge pull request 'Add contributing guidelines' (#138) from dvzrv/contributing into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/138
2023-11-22 11:45:58 +00:00
David Runge
f4ed0b2de1
Add contributing guidelines
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-22 12:20:37 +01:00
heiko
f6a07df24a Merge pull request 'Add numbering for all figures in flat hierarchy and add alt-text and names for all figures' (#132) from dvzrv/numfig_and_alt_text into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/132
2023-11-20 18:43:07 +00:00
Heiko Schaefer
bf3c72d855
Adjust color description 2023-11-20 19:41:42 +01:00
David Runge
83a07f0001
Add name and alt attributes for all figures
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-20 19:13:19 +01:00
David Runge
514bb02d3d
Configure sphinx to render numbering for figures in flat hierarchy
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-20 16:24:10 +01:00
Heiko Schaefer
5cb7b94950
moved to #119 2023-11-18 17:14:53 +01:00
Heiko Schaefer
0389d75da0
ch4: drop minor redundancy 2023-11-17 14:50:37 +01:00
Heiko Schaefer
4ddbeb9e5a
use "signature packet" for disambiguation 2023-11-17 14:47:55 +01:00
Heiko Schaefer
3d02f4ae88
Fix swapped description
(From #112)
2023-11-17 14:30:05 +01:00
Heiko Schaefer
c43b444980
RNP is independent of Thunderbird 2023-11-17 13:34:18 +01:00
Heiko Schaefer
9b925ffd9c
fix list dash 2023-11-17 00:14:09 +01:00
Tammi L. Coles
25bd959aaf Merge pull request 'tammi-ch6' (#116) from tammi-ch6 into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/116
2023-11-16 21:16:25 +00:00
Tammi L. Coles
5259fb0606 Merge branch 'draft' into tammi-ch6 2023-11-16 21:09:26 +00:00
Tammi L. Coles
e6c935eec9 remove 'and providing varying levels of security' 2023-11-16 22:08:05 +01:00
Heiko Schaefer
4277942114
ch8: typo fix 2023-11-16 17:31:16 +01:00
heiko
8db1df2a91 Merge pull request 'ch7: edits by tammi plus text by heiko' (#117) from tammi-heiko-ch7 into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/117
2023-11-16 16:26:02 +00:00
heiko
a02c7562f0 Merge branch 'draft' into tammi-heiko-ch7 2023-11-16 16:25:43 +00:00
Tammi L. Coles
1b1e918a01 add detail to ch7 pitfalls section of cleartext signatures 2023-11-16 15:16:05 +01:00
Heiko Schaefer
32b5e0cfe0
Align wording with https://gitlab.com/openpgp-wg/rfc4880bis/-/merge_requests/354/diffs 2023-11-16 13:31:10 +01:00
Tammi L. Coles
58340c97a1 edit ch7 cleartext transformations subsection 2023-11-16 11:57:46 +01:00
Tammi L. Coles
2f44224974 edit ch7 section on use case 2023-11-16 11:14:16 +01:00
Tammi L. Coles
7ed65cc02c make second-pass edits to ch7 2023-11-16 09:48:07 +01:00
Heiko Schaefer
0def7f33ae
add link anchor 2023-11-15 12:31:08 +01:00
Heiko Schaefer
c410108a67
ch8: add link anchor 2023-11-14 22:06:02 +01:00
Heiko Schaefer
d47d9fdd53
clarify 2023-11-14 19:50:30 +01:00
Heiko Schaefer
5a454e85e7
extend todo-note 2023-11-14 19:50:29 +01:00
Heiko Schaefer
77d056702a
clarity, fix typo, normalize capitalization 2023-11-14 19:28:48 +01:00
Heiko Schaefer
1e231b0f45
adjust RFC linking, minor tweaks.
I removed the "type IDs" here, because these are *packet type* IDs. The only IDs we're using in the text are *signature types*. I believe signature type IDs are the only IDs that application developers sometimes think about in numerical terms.
2023-11-14 19:28:47 +01:00
Heiko Schaefer
ad7b58ce71
clarify/tighten: there is just *one* signature packet in this paragraph. 2023-11-14 13:35:11 +01:00
Heiko Schaefer
029e517b84
removed "particularly", because for inline signatures, this issue doesn't exist at all. added the "cleartext" case, which is equivalent here. 2023-11-14 13:20:14 +01:00
Heiko Schaefer
94eb58070b
Attempt at clearer description 2023-11-14 11:33:26 +01:00
Heiko Schaefer
6db0a1f841
Merge branch 'tammi-ch7' into heiko-ch7
# Conflicts:
#	book/source/07-signing_data.md
2023-11-13 23:56:27 +01:00
Tammi L. Coles
78c8327733 edit ch7 cleartext signature 2023-11-13 22:36:05 +01:00
Tammi L. Coles
e6b9c11a3d edit ch7 inline signatures 2023-11-13 22:06:35 +01:00
Tammi L. Coles
17d43e0e91 edit ch7 inline signatures 2023-11-13 21:33:03 +01:00
Tammi L. Coles
62af0cb83b edit ch7 detached signatures 2023-11-13 21:27:37 +01:00
Tammi L. Coles
ee65b80bc7 default to data signatures not signature over data 2023-11-13 21:20:09 +01:00
Tammi L. Coles
7e89a9f11f remove blank line 2023-11-13 21:18:15 +01:00