Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • 14-sphinx-directory-double-checked
  • 6-landing-page-overhaul_v2
  • sabine_11-technical-guide-with-links-to-all-repos-has-been-created
  • HISA-preparation
5 results
Name Last commit Last update
css
documentation
footer
icons_MBresser_v1
images
logos
sphinx
subpages
.gitignore
LICENSE
README.md
index.html
README.md

Description:

This repository holds all documents and scripts to build the landing page of the TOAR Data Infrastructure website for surface data.

The data in this repository is needed to create documentation for the individual topics around the TOAR-II database and its infrastructure. The documentation is automatically created for both formats, pdf and HTML. The automatic generation of the documentation from the same source files ensures that the online documentation does not deviate from the static documentation. In addition, some tables can be generated automatically from database queries or source code and can be exchanged without effort if necessary. Referencing such tables in different documents also ensures consistency. These documents are needed for general information as well as for specific information for the operation of the TOAR database. Colour coding is used for the pdf title page and the HTML layout to simplify the handling of the documentation so that the readers recognise the information that is relevant to them at first glance:

  • User Guides are blue,
  • Technical Guides are green, and
  • General Guides are black.

css: This folder holds all style sheets (css: „Cascading Style Sheets“) to generate the TOAR-II webpage with an base layout, footer, header and style.

documentation: In the documentations folder, all ready generated pdfs are available for download.

footer: This directory contains all legal informations about imprint, privacy and terms-of-use like data use policy.

logos: All logos used on the TOAR-II landing page

sphinx: The folder sphinx contains all sources to generate the documents as HTML file and pdf file. Here, you will find a separate README.md file to explain the document creation in more detail.

icons: Suggestions for icons to structure the landing page

Installation/Deployment:

This is a Linux based version. After cloning (https example: https://gitlab.jsc.fz-juelich.de/esde/toar-data/toar-data-landing-page.git), you are free to customize the documents to fit your applications.

With this data package you are able to generate both pdfs and html pages.

For using the automatic document creation, please follow the instructions in sphinx/README.md.