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.0.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.0-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rst2typst-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 78b52fcf26ecbdbb25bcb8ab16268ab285e169031be4a526d3480b9c8926ceb5
MD5 e800cde1cfd26ed34cd9bd34ea85018e
BLAKE2b-256 b11ebea907ab0092d6b1ab07b29020f3162d5d20b3b65bf045e5ecd96fba3ba5

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: rst2typst-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 42dd37b736309d6c2adbb85bb15f9127e1c1d6478a70cc6cf78f0eedc6851be9
MD5 e34589ef76ff4054108e10180db379b6
BLAKE2b-256 1759148ea098db4d9c5432c6ba3a6b40b301c04a294726c35bc16b7dcf85ef61

See more details on using hashes here.

Provenance

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