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.0.0.tar.gz (8.0 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.0.0-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rst2typst-0.0.0.tar.gz
Algorithm Hash digest
SHA256 74e0098b3d2ff25ffa66eacde84f78fb0505fb66cd07d72ac6936f2f42324f6d
MD5 124220d4230faaf59a61f518676928de
BLAKE2b-256 6517442bca03e380d1d28b7e5b4f7388ddfb5254a9862e738f6a9785b8cec9ce

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: rst2typst-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 10.8 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41eae9aeb2ce4369febcaa3ab0ed91a27e83dbe1b9caf5aade3d041900fdc7af
MD5 41a9a1bc6215a9c98a94ee9a14fe512c
BLAKE2b-256 83c868d3fae0058a8ba204795ae487bb400fd1314d5cfbc87aee22aac03fd1d2

See more details on using hashes here.

Provenance

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