https://github.com/devives/rst-document

Java reStructuredText Document & Builder
https://github.com/devives/rst-document

builder document rest restructuredtext rst

Last synced: 6 months ago
JSON representation

Java reStructuredText Document & Builder

• Host: GitHub
• URL: https://github.com/devives/rst-document
• Owner: devives
• License: gpl-2.0
• Created: 2024-01-27T07:25:52.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-10-19T19:32:44.000Z (9 months ago)
• Last Synced: 2025-10-20T01:47:39.933Z (9 months ago)
• Topics: builder, document, rest, restructuredtext, rst
• Language: Java
• Homepage:
• Size: 136 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE-GPL-2.0

Awesome Lists containing this project

README

          
===================================

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 `_.

.. contents:: Overview

   :depth: 2

Quick Start

-----------

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

   .. code:: gradle

      repositories {

          mavenCentral()

      }

#. Add library to dependencies:

   .. code:: gradle

      dependencies {

          implementation 'com.devives:devive-rst-document:0.2.0'

      }

Sample code

-----------

.. code:: java

   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 `_

.. footer::

   This document generated using `this code `_.