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.

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.1.1.tar.gz (8.2 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.1.1-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rst2typst-0.1.1.tar.gz
Algorithm Hash digest
SHA256 777275cb96dbe41a1a2c52b2a37471c8cd3df2f651b868f0ba5aacf9bd0ca8e1
MD5 9a9af34521f0f24381df448fa6a0b4d4
BLAKE2b-256 a041b71730bf1df90629bd38a9f1a18aa95ee3c4edc06dd6e7a15247be62884a

See more details on using hashes here.

Provenance

The following attestation bundles were made for rst2typst-0.1.1.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.1.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for rst2typst-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d83c66307c3a21bea2e2226c0aae35b02eb562c91b4940a8a54d0d4d08e51c74
MD5 659779758393b990126931f43d53635d
BLAKE2b-256 b4f5d7ec234d021c6140e765f1a427b982a8e5b6cf98243056b96a108e754f4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for rst2typst-0.1.1-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