README.rst

ReStructuredText Document & Builder for Sphinx

This project is the library which extends ReStructuredText Document and Builder library.

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

Overview

• Quick Start
• Sample code
• License
• Links

Quick Start

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

   repositories {
       mavenCentral()
   }

2. Add library to dependencies:

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

Sample code

private String codeSample() {
    return Rst4Sphinx.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

• Documentation » Using Sphinx » reStructuredText

---

This document generated using this code.