Introduction

ELT ICS is the Instrument Control System Framework being developed by ESO for consortia. It is aimed to provide the building blocks to help developing the ELT instrument control systems. The purpose of this guide is to build an agile documentation reference that would help developers implementing parts of the framework.

Contents

• Introduction
  • Guide Contribution
  • SphinX and RST Syntax Guide
  • Converting docx to RST
    • Converting docx files with Images

Guide Contribution

To view & edit locally, check it out and run “make html”:

$ svn co http://svnhq9.hq.eso.org/p9/trunk/EELT/ICS/Documents/DeveloperGuide
$ cd DeveloperGuide
$ make html
$ firefox build/html/index.html&

Note

Instead of ‘make html’ you may want to use ‘make clean html’ when sources are located on NFS shares.

Additionally, you might want to perform automatic rebuilds by having entr monitor the files for changes:

$ find -name \*.rst | entr make html

Note

There are two main parts for the moment (getting started & code style). Feel free to add more. A convention was used to group the main parts in their own directories part-: “part-getting-started” and “part-style-guide”.

SphinX and RST Syntax Guide

Here you can find a simple reference.

Converting docx to RST

To convert Word documents (.docx) you can use the pantoc tool.

<http:www.pandoc.org>

The command is:

pandoc -s <input file>.docx -t rst -o <output file>.rst

Warning

You might need to correct the output file after conversion.

Converting docx files with Images

The command is:

pandoc --extract-media=./MyMediaFolder -s <input file>.docx -t rst -o <output file>.rst

Note

Images and other media inside the docx file will be stored in directory MyMediaFolder.

Warning

It might be needed to adjust the image references in the document so they point to the extracted files.