Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to reStructuredText + sphinx #371

Merged
merged 84 commits into from
Jul 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
9c13bfd
switch to sphinx
multun Jun 5, 2020
56ea91c
fixup building blocks rst
multun Jun 3, 2020
bfa062c
add missing OTR publication details
multun Jun 4, 2020
4355cf8
fix appendices
multun Jun 4, 2020
dad223e
fix complete cryptosystems rst
multun Jun 4, 2020
37eff1e
fix verbatim sequences
multun Jun 4, 2020
94e6e4a
fix incorrect image path
multun Jun 4, 2020
baf66f6
fix book version
multun Jun 4, 2020
1e99796
fixup foreword rst conversion
multun Jun 4, 2020
598d257
add missing empty bib booktitle for bellarecanettikrawczyk:keyinghash
multun Jun 5, 2020
3e35326
fix broken internal links
multun Jun 5, 2020
cda29e2
fix citations
multun Jun 5, 2020
2cca93f
building-blocks: fix broken image alignment
multun Jun 5, 2020
4219d09
building-blocks: fix broken inline math exprs
multun Jun 5, 2020
6b3bbad
add support for the advanced admonitions
multun Jun 5, 2020
49db85e
add a "star on github" button
multun Jun 5, 2020
30181d7
fix some more broken links
multun Jun 5, 2020
9b01d78
setup transifex translation
multun Jun 5, 2020
9539616
remove the -fr in the site title
multun Jun 5, 2020
27062ce
add a title to the index page
multun Jun 5, 2020
b8fe92f
add a localized make wrapper
multun Jun 5, 2020
14acdba
ignore generated svg illustrations
multun Jun 5, 2020
e9daf4f
fix texescape API issue
multun Jun 5, 2020
784dcf2
appendices: add missing math section
multun Jun 5, 2020
67beace
compress pdf assets
multun Jun 5, 2020
2e33879
get rid of the glossary
multun Jun 5, 2020
be3e231
update dockerfile dependencies
multun Jun 5, 2020
5237316
tweak latex export settings to approach reference document
multun Jun 5, 2020
68832d1
downscale ModularArithmetic illustrations
multun Jun 6, 2020
93eb3e1
building-blocks: latex fixes
multun Jun 6, 2020
12943ac
add multi-language build support
multun Jun 6, 2020
63b078e
fix invisible cross on clock illustration
multun Jun 6, 2020
46f9deb
appendices: fix section title
multun Jun 6, 2020
70304f1
travis: build all languages
multun Jun 7, 2020
770f2e5
various build fixes
multun Jun 7, 2020
99eef7e
fix illustration name conflict
multun Jun 7, 2020
7f0bd03
get closer to the org-mode style
multun Jun 7, 2020
dda8750
add glossary
multun Jun 7, 2020
6b8620f
improve the index display
multun Jun 7, 2020
549a4e4
avoid using latex in bibliography
multun Jun 7, 2020
435eedd
fix quote formatting
multun Jun 7, 2020
1f5256d
sort the glossary
multun Jun 7, 2020
11f2058
move hyperref setup to a dedicated file
multun Jun 7, 2020
c19af53
better title page
multun Jun 7, 2020
2195f24
fix title style
multun Jun 7, 2020
c9f4d03
setup the header
multun Jun 7, 2020
33a2e6a
document the sphinx configuration
multun Jun 7, 2020
fbe5a8f
change the release directory to _release
multun Jun 7, 2020
fa7bbaa
make the clocks smaller
multun Jun 7, 2020
228c6a8
add the release build script
multun Jun 7, 2020
36e3b9e
move footnotes inside the relevant pages
multun Jun 7, 2020
3037b11
split building-blocks.rst
multun Jun 7, 2020
f5e46a2
split complete-cryptosystems.rst
multun Jun 7, 2020
05c488f
remove newline from project version
multun Jun 7, 2020
0151a90
update the i18n build dir
multun Jun 7, 2020
14d9b41
fix assets makefile
multun Jun 7, 2020
409a2eb
register new files into transifex
multun Jun 7, 2020
f4663d4
fix travis file upload
multun Jun 7, 2020
42d6a5b
fix probability table
multun Jun 7, 2020
2d6e5c9
style h5 and h6
multun Jun 7, 2020
3f7e640
add references to glossary
multun Jun 8, 2020
cda88e2
reformat conf.py
multun Jun 8, 2020
161c334
fix the title page margins
multun Jun 8, 2020
f359b9e
port the link color over from org
multun Jun 8, 2020
df04ee5
add an init to the docker container
multun Jun 8, 2020
8f55c9e
better admonitions
multun Jun 8, 2020
255ba5c
better epub support
multun Jun 9, 2020
7b8a0a0
fix broken bib urls
multun Jun 9, 2020
dc2a346
fix latex admonitions bugs
multun Jun 9, 2020
30dce7b
remove unused dependencies
multun Jun 9, 2020
55e7f37
move sources to src/
multun Jun 9, 2020
2a51437
org2rst isn't needed anymore, the conversion is complete
multun Jun 9, 2020
75aae86
handle non-root docker
multun Jun 9, 2020
e55248f
support sphinx < 2.1.0 for admonitions
multun Jun 9, 2020
2a78116
update the README
multun Jun 9, 2020
60aa408
add an ubuntu Dockerfile
multun Jun 14, 2020
5b3a65c
add a `book` make target
multun Jun 14, 2020
658f5f6
make the LICENSE link clickable
multun Jun 14, 2020
2df5632
add support for subfigures
multun Jun 14, 2020
15b7f6a
admonition_templates: handle singlehtml output
multun Jun 14, 2020
180ff77
removed buggy scale attribute
multun Jun 17, 2020
c6d7d22
add missing admonition environment merge logic
multun Jun 17, 2020
ad4c64b
make references look better for html
multun Jun 17, 2020
42c45ce
README: document language codes
multun Jul 8, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ Crypto101.epub
*~
# Source highlighting
_minted-Crypto101
# Illustrations, vectorized
Illustrations/*/*.pdf
*.mps
*.mpx
*.mpo
# Illustrations that start as PDF
!Illustrations/CC/CC-BY-NC.pdf
# OS X stuff
.DS_Store
.auctex-auto
.mypy_cache
.venv
_build
10 changes: 4 additions & 6 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,15 @@ services:
jobs:
include:
- script: |
docker build -t crypto101 .
docker run -it -v ${TRAVIS_BUILD_DIR}:/repo crypto101 /bin/bash -c '
set -e # exit on failure
set -x # trace for debug
make' bash
docker build -t crypto101 docker/
docker run --rm -it -v ${TRAVIS_BUILD_DIR}:/repo crypto101 ./build_release ./_release/

deploy:
provider: releases
skip_cleanup: true
api_key:
secure: ex7uUwr09xvZd+UnbYNYJ+YcAkziLZ39UTg4FM0OKd6KaYPBqVucndkIsQz5LV1gO6YmVZpvCkGMVWMduI0AH8DzuAidRhtV9Ejr3t2tZOmnEJeKBAK+eKfLqeiVQ29ywAn+MtjwZziaKvGcAfXRwVI9ksWg81kO2mIYrGnDN/WTZUsYTMYp0wbfNNwXLEGamz4BMTDwoLA8jDtwwtmwxujLvgWepISeDj1fveTJcGBQHy0zeJVCUPfYT1alceZW04CYQKrU0dXjdES8q6ab3jFqUFqkYQnMCuB+QXThitBmzoxjCxPGdBrZ2C6t/hGnrL0QuE9IUxkdIkcDV69RVuG3SlnKAE4bmMf+ydG633Mmh7A4aVCgUS6TzgHpSJlWbsE2/CJA6JPRDqWr6iHKy/3gEmEnANC2rRLwaO75MJaP6qDHFNgYCB+3buzsgoHvF2274g5xro5wenzugJ/vH4P5qy98Ad12sHuXVCXQyOW/rqLN9M+uuba0NgZW4+WUGX/gssO/CbZPl3W7mEth+LN7Qtnvn2OO6P8tf6Tl5LPh6T9LrfXEJDUVBI0bql8ujIG3agzemrPTjzfvdzIPulnCj8QEbOl1VyOWnmroa+fZd6G25umXxnXBKiPSdfpgqGL5A1hSRqbyg2xtLKl4B8hhxwNSntW/pvqd8bdqnqI=
file: Crypto101.pdf
file_glob: true
file: _release/*
on:
repo: crypto101/book
122 changes: 122 additions & 0 deletions .tx/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
[main]
host = https://www.transifex.com

[crypto101.building-blocks]
file_filter = src/locale/<lang>/LC_MESSAGES/building-blocks.po
source_file = _build_en/gettext/building-blocks.pot
source_lang = en
type = PO

[crypto101.index]
file_filter = src/locale/<lang>/LC_MESSAGES/index.po
source_file = _build_en/gettext/index.pot
source_lang = en
type = PO

[crypto101.complete-cryptosystems]
file_filter = src/locale/<lang>/LC_MESSAGES/complete-cryptosystems.po
source_file = _build_en/gettext/complete-cryptosystems.pot
source_lang = en
type = PO

[crypto101.appendices]
file_filter = src/locale/<lang>/LC_MESSAGES/appendices.po
source_file = _build_en/gettext/appendices.pot
source_lang = en
type = PO

[crypto101.references]
file_filter = src/locale/<lang>/LC_MESSAGES/zreferences.po
source_file = _build_en/gettext/zreferences.pot
source_lang = en
type = PO

[crypto101.foreword]
file_filter = src/locale/<lang>/LC_MESSAGES/foreword.po
source_file = _build_en/gettext/foreword.pot
source_lang = en
type = PO

[crypto101.block-ciphers]
file_filter = src/locale/<lang>/LC_MESSAGES/block-ciphers.po
source_file = _build_en/gettext/block-ciphers.pot
source_lang = en
type = PO

[crypto101.exclusive-or]
file_filter = src/locale/<lang>/LC_MESSAGES/exclusive-or.po
source_file = _build_en/gettext/exclusive-or.pot
source_lang = en
type = PO

[crypto101.glossary-]
file_filter = src/locale/<lang>/LC_MESSAGES/glossary.po
source_file = _build_en/gettext/glossary.pot
source_lang = en
type = PO

[crypto101.hash-functions]
file_filter = src/locale/<lang>/LC_MESSAGES/hash-functions.po
source_file = _build_en/gettext/hash-functions.pot
source_lang = en
type = PO

[crypto101.key-derivation-functions]
file_filter = src/locale/<lang>/LC_MESSAGES/key-derivation-functions.po
source_file = _build_en/gettext/key-derivation-functions.pot
source_lang = en
type = PO

[crypto101.key-exchange]
file_filter = src/locale/<lang>/LC_MESSAGES/key-exchange.po
source_file = _build_en/gettext/key-exchange.pot
source_lang = en
type = PO

[crypto101.message-authentication-codes]
file_filter = src/locale/<lang>/LC_MESSAGES/message-authentication-codes.po
source_file = _build_en/gettext/message-authentication-codes.pot
source_lang = en
type = PO

[crypto101.off-the-record-messaging]
file_filter = src/locale/<lang>/LC_MESSAGES/off-the-record-messaging.po
source_file = _build_en/gettext/off-the-record-messaging.pot
source_lang = en
type = PO

[crypto101.openpgp-and-gpg]
file_filter = src/locale/<lang>/LC_MESSAGES/openpgp-and-gpg.po
source_file = _build_en/gettext/openpgp-and-gpg.pot
source_lang = en
type = PO

[crypto101.public-key-encryption]
file_filter = src/locale/<lang>/LC_MESSAGES/public-key-encryption.po
source_file = _build_en/gettext/public-key-encryption.pot
source_lang = en
type = PO

[crypto101.random-number-generators]
file_filter = src/locale/<lang>/LC_MESSAGES/random-number-generators.po
source_file = _build_en/gettext/random-number-generators.pot
source_lang = en
type = PO

[crypto101.signature-algorithms]
file_filter = src/locale/<lang>/LC_MESSAGES/signature-algorithms.po
source_file = _build_en/gettext/signature-algorithms.pot
source_lang = en
type = PO

[crypto101.ssl-and-tls]
file_filter = src/locale/<lang>/LC_MESSAGES/ssl-and-tls.po
source_file = _build_en/gettext/ssl-and-tls.pot
source_lang = en
type = PO

[crypto101.stream-ciphers]
file_filter = src/locale/<lang>/LC_MESSAGES/stream-ciphers.po
source_file = _build_en/gettext/stream-ciphers.pot
source_lang = en
type = PO
Loading