docs2epub
Turn documentation sites into an EPUB (Kindle-friendly).
Initial focus: Docusaurus sites that expose a Next button (docs navigation).
Install (dev)
This project uses Python 3.12+.
uv sync
uv run docs2epub --help
Usage
uvx (no install)
uvx docs2epub \
https://www.techinterviewhandbook.org/software-engineering-interview-guide/ \
tech-interview-handbook.epub
# Optional (override inferred metadata)
uvx docs2epub \
https://www.techinterviewhandbook.org/software-engineering-interview-guide/ \
tech-interview-handbook.epub \
--title "Tech Interview Handbook" \
--author "Yangshun Tay"
# Optional: skip images
uvx docs2epub \
https://www.techinterviewhandbook.org/software-engineering-interview-guide/ \
tech-interview-handbook.epub \
--no-images
Docusaurus “Next” crawl
# Default output is EPUB2 (Kindle-friendly) via pandoc
uv run docs2epub \
--start-url "https://www.techinterviewhandbook.org/software-engineering-interview-guide/" \
--out "dist/tech-interview-handbook.epub" \
--title "Tech Interview Handbook" \
--author "Yangshun Tay"
# Optional: build EPUB3 (ebooklib)
uv run docs2epub \
--format epub3 \
--start-url "https://www.techinterviewhandbook.org/software-engineering-interview-guide/" \
--out "dist/tech-interview-handbook.epub" \
--title "Tech Interview Handbook" \
--author "Yangshun Tay"
Roadmap
- Add additional discovery strategies:
sitemap.xml, sidebar parsing, and explicit link lists. - Optional: send-to-kindle (email), once Gmail auth is set up.
Release files for docs2epub 0.1.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| docs2epub-0.1.12.tar.gz | 56.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| docs2epub-0.1.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 71.1 kB
Release files / docs2epub-0.1.12.tar.gz
| Download URL | docs2epub-0.1.12.tar.gz |
|---|---|
| Size | 56.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
43776264f5c7791d16d0fc2bdfed7a8ce6ad3f05b0808b59c3a743b386ba30de
|
|
BLAKE2b-256 checksum How to use checksums |
2556a3e04fef3306ce26e158212fa82a33754f862a41bc79d559675e9f192035
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.4 {"installer":{"name":"uv","version":"0.11.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / docs2epub-0.1.12-py3-none-any.whl
| Download URL | docs2epub-0.1.12-py3-none-any.whl |
|---|---|
| Size | 15.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fbc150f704ca4796ac0c43fc14c276203141610d0b5a6c2297ada706791888c6
|
|
BLAKE2b-256 checksum How to use checksums |
1a380b10f055fb9ab85ea8c9c155b7174e55a740b01b54466a001154fa6d1361
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.4 {"installer":{"name":"uv","version":"0.11.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|