Skip to content

earthobservations/goethe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

goethe

Create RST documents programmatically with Python

CI: Overall outcome CI: Code coverage PyPI version Project status (alpha, beta, stable) PyPI downloads Project license Python version compatibility Documentation: Black

WARNING: THIS PROJECT IS CURRENTLY IN ALPHA STAGE. DON'T USE IN PRODUCTION!


Introduction

Goethe gives you the opportunity to create your individual RST project in Python

  1. programmatically - write your project as Python script in OOP style, place variables where ever you want
  2. dynamically - render the project to dict, json or actual files and even PDF

Setup

Via Pip:

pip install goethe

Via Github (latest):

pip install git+https://github.com/earthobservations/goethe

Structure

Goethe uses 3 main levels of abstraction:

  • Goethe - initialize an RST project with a Goethe
  • FlatChapter - add a chapter based on one file at the same level as the Goethe
  • DeepChapter - add a chapter based on a folder with its own index

A simple project could look like e.g.

Goethe("myproj")
FlatChapter("overview")
DeepChapter("depper_level)
    FlatChapter("overview")
    DeepChapter("second_chapter")

with following file structure:

./
index.rst
overview.rst

./deeper_level
index.rst
overview.rst

./deeper_level/second_chapter
index.rst

Features

  • setup a RST project
  • export to dict, files or html
  • flat and deep chapters to build unlimited depth of documentation
  • modules of RST:
    • toctree
    • paragraph

Backlog

Examples

Visualized examples can be found in the examples folder.

License

Distributed under the MIT License. See LICENSE for more info.

Backlog

Changelog

Development