Create RST documents programmatically with Python
Introduction
Goethe gives you the opportunity to create your individual RST project in Python
programmatically - write your project as Python script in OOP style, place variables where ever you want
dynamically - render the project to dict, json or actual files and even PDF
Setup
Via Pip:
pip install goetheVia Github (latest):
pip install git+https://github.com/earthobservations/goetheStructure
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.rstFeatures
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
1 maintainer
Metadata
1 maintainer
Release files for goethe 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| goethe-0.1.0.tar.gz | 6.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| goethe-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.8 kB
Release files / goethe-0.1.0.tar.gz
| Download URL | goethe-0.1.0.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d1623f4f87c279cbedcc525743eb0fee9b8bbedc80edcaf6cc4b66ea0286d0de
|
|
BLAKE2b-256 checksum How to use checksums |
ec615dceabec54cce0af37e4120ae47e2533d6c9e6d3c77697234c97d7d7be05
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.10.8 Linux/5.15.0-1022-azure
|
Release files / goethe-0.1.0-py3-none-any.whl
| Download URL | goethe-0.1.0-py3-none-any.whl |
|---|---|
| Size | 9.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6f9619b8d962d4bd9d4fe5d3e3188c6b7ac903ad1573bb8ec33a04ddb516fc85
|
|
BLAKE2b-256 checksum How to use checksums |
30f74650dfc46b00693f84efc1feb636074c92ef80154c50e68d731d3b984c83
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.10.8 Linux/5.15.0-1022-azure
|
