Converter from DocTree of docutils to Typst source and PDF.
Overview
rst2typst is Python project that includes docutils custom writer and frontend CLI.
I develop this for two purposes:
To generate PDF documentation from reStructuredText rapidly.
To work as core of atsphinx-typst that it is Sphinx extension to generate PDF file on Sphinx lifecycle.
I will use this and atsphinx-typst to generate documentation PDF files of my Python projects.
Benchmark
rst2typstpdf is about 53.5x faster than rst2latex+pdflatex when including the installation of TeX Live (1.7 s vs 92.3 s).
For full details, see Benchmark in the documentation.
Usage
Use CLI
You write reStructuredText source to generate for PDF using Typst. (e.g. this filename is document.rst.)
==================
rst2typst document
==================
Overview
========
We like reStructuredText! It is an one of great docutils.
* This has custom writer of docutils.
* This has CLI endpoint named ``rst2typst`` and ``rst2typstpdf``.
Usage
=====
Enjoy it!You can run these command to convert to Typse code.
rst2typst document.rst document.typGenerated document.typ has this content (actually this is not formated).
#title([rst2typst document])
= Overview
We like reStructuredText! It is an one of great docutils.
- This has custom writer of docutils.
- This has CLI endpoint named `rst2typst` and `rst2typstpdf`.
= Usage
Enjoy it!Use as library
(TBD)
License
Apache-2.0 license. Please see LICENSE on repository.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rst2typst-0.6.0.tar.gz.
File metadata
- Download URL: rst2typst-0.6.0.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
27220902bafcf5decbf87ee6f07e84ce7c27db3917aaa3f617be7e06b86492c6
|
|
| MD5 |
025c4108a10c348a856b6c3130e52c8b
|
|
| BLAKE2b-256 |
8f087a959d02c86595cb48c2611462aef9cc1689f7f0aa38d7b86ed98a019103
|
Provenance
The following attestation bundles were made for rst2typst-0.6.0.tar.gz:
Publisher:
release.yaml on atsphinx/rst2typst
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
rst2typst-0.6.0.tar.gz -
Subject digest:
27220902bafcf5decbf87ee6f07e84ce7c27db3917aaa3f617be7e06b86492c6 - Sigstore transparency entry: 2193278241
- Sigstore integration time:
-
Permalink:
atsphinx/rst2typst@333a7216d8e26581af59381d74df54d52e72563e -
Branch / Tag:
refs/tags/v0.6.0 - Owner: https://github.com/atsphinx
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@333a7216d8e26581af59381d74df54d52e72563e -
Trigger Event:
push
-
Statement type:
File details
Details for the file rst2typst-0.6.0-py3-none-any.whl.
File metadata
- Download URL: rst2typst-0.6.0-py3-none-any.whl
- Upload date:
- Size: 15.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
083278cf39c3eea1eed6f0b115c619eebd76ee9b8e121350e6d489687686a229
|
|
| MD5 |
dcb56ebe2f1906eef9a80d6376c12fd8
|
|
| BLAKE2b-256 |
1a8c238cc2e09714da3628479be43606ffdd3ca1e6dcb943642a1b2737ec03c0
|
Provenance
The following attestation bundles were made for rst2typst-0.6.0-py3-none-any.whl:
Publisher:
release.yaml on atsphinx/rst2typst
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
rst2typst-0.6.0-py3-none-any.whl -
Subject digest:
083278cf39c3eea1eed6f0b115c619eebd76ee9b8e121350e6d489687686a229 - Sigstore transparency entry: 2193278263
- Sigstore integration time:
-
Permalink:
atsphinx/rst2typst@333a7216d8e26581af59381d74df54d52e72563e -
Branch / Tag:
refs/tags/v0.6.0 - Owner: https://github.com/atsphinx
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@333a7216d8e26581af59381d74df54d52e72563e -
Trigger Event:
push
-
Statement type:
