ReStructuredText Document & Builder

This project is the library for building reStructuredText document object and serializing it into text representation.

The library is part of the project RstDoclet for JavaDoc Tool, generating reStructuredText for Sphinx.

Overview

Quick Start

1. Add mavencentral() repository to your root build.gradle:

   repositories {
       mavenCentral()
   }

2. Add library to dependencies:

   dependencies {
       implementation 'com.devives:devive-rst-document:0.2.0'
   }

Sample code

private String codeSample() {
    return Rst.builders().document()
        .title("Document title", true)
        .paragraph("Simple text without any emphasis or enhancements.")
        .subTitle("Section title")
        .beginParagraph().text("Text can contains emphasis like ").bold("bold")
        .text(" or ").italic("italic").text(" text.").end()
        .build()
        .serialize();
}

will return

==============
Document title
==============

Simple text without any emphasis or enhancements.

Section title
-------------

Text can contains emphasis like **bold** or *italic* text.

License

The code of project distributed under the GNU General Public License version 2 or any later version. The source code is available on GitHub.

Links

• An Introduction to reStructuredText
• reStructuredText Markup Specification
• reStructuredText Directives
• reStructuredText Interpreted Text Roles
• The Docutils Document Tree

This document generated using this code.