Skip to main content

Converter from docutils AST to Typst source

Project description

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.typ

Generated 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rst2typst-0.3.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rst2typst-0.3.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file rst2typst-0.3.0.tar.gz.

File metadata

  • Download URL: rst2typst-0.3.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rst2typst-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1c676d01cbace78218e71344e18b9a5c99021ef6f4883d8a67259012519cfbda
MD5 1b76ec8008f89679983c54ff85b0f74d
BLAKE2b-256 c8393a5e28dbd60204b5b5dfa06beaff6399ed981882d6b357b79060649dc306

See more details on using hashes here.

Provenance

The following attestation bundles were made for rst2typst-0.3.0.tar.gz:

Publisher: release.yaml on atsphinx/rst2typst

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rst2typst-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: rst2typst-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rst2typst-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91ce57b1480a8cd608c60b1b65b34d34d679c988e385401b51d76f35a96216d9
MD5 5ca362ebcf44c5d02b49d0b550796ba1
BLAKE2b-256 d8f83fe8d2f7a09e38578c2e68786f982ca8e459aaacc11f8c730096d030e8fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for rst2typst-0.3.0-py3-none-any.whl:

Publisher: release.yaml on atsphinx/rst2typst

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page