From 4dda6c570c069bf1b64254e89d3d6605766fd823 Mon Sep 17 00:00:00 2001 From: Fabrice Salvaire Date: Tue, 25 Dec 2018 20:06:59 +0100 Subject: [PATCH] doc --- README.html | 1 + README.rst | 2 ++ README.txt | 2 ++ doc/sphinx/source/features.txt | 17 +++++++++++++++++ doc/sphinx/source/index.rst | 8 ++++---- doc/sphinx/source/overview.rst | 18 ++---------------- 6 files changed, 28 insertions(+), 20 deletions(-) create mode 100644 doc/sphinx/source/features.txt diff --git a/README.html b/README.html index 9d79b0f..7309918 100644 --- a/README.html +++ b/README.html @@ -391,6 +391,7 @@ ul.auto-toc {

What is PythonicGcodeMachine ?

PythonicGcodeMachine is a Python toolkit to work with RS-274 / ISO G-Code.

+

Where is the Documentation ?

diff --git a/README.rst b/README.rst index 6269f70..29192af 100644 --- a/README.rst +++ b/README.rst @@ -101,6 +101,8 @@ What is PythonicGcodeMachine ? PythonicGcodeMachine is a Python toolkit to work with RS-274 / ISO G-Code. +.. include: features.txt + Where is the Documentation ? ---------------------------- diff --git a/README.txt b/README.txt index 6b35949..ca7dcbd 100644 --- a/README.txt +++ b/README.txt @@ -25,6 +25,8 @@ What is PythonicGcodeMachine ? PythonicGcodeMachine is a Python toolkit to work with RS-274 / ISO G-Code. +.. include: features.txt + Where is the Documentation ? ---------------------------- diff --git a/doc/sphinx/source/features.txt b/doc/sphinx/source/features.txt new file mode 100644 index 0000000..842abe5 --- /dev/null +++ b/doc/sphinx/source/features.txt @@ -0,0 +1,17 @@ +.. -*- mode: rst -*- + +PythonicGcodeMachine features: + +* a compliant RS-274 / ISO G-code parser which is automatically generated from grammar and easy to + derivate to support other flavours, +* an abstract syntax tree (AST) API, +* some G-code flavour aspects are handled by YAML files for maximum flexibility, +* tools to manipulate and validate G-code, +* and more .. + +PythonicGcodeMachine supports these G-code flavours: + +* RS-274 **(full support)** +* Fanuc *(partially)* +* Heidenhain *(partially)* +* LinuxCNC *(partially)* diff --git a/doc/sphinx/source/index.rst b/doc/sphinx/source/index.rst index bd74139..1001521 100644 --- a/doc/sphinx/source/index.rst +++ b/doc/sphinx/source/index.rst @@ -37,9 +37,9 @@
-############################ - The Pythonic Gcode Machine -############################ +############################# + The Pythonic G-code Machine +############################# .. .. image:: /_static/logo.png .. :alt: PythonicGcodeMachine logo @@ -49,7 +49,7 @@ Overview ******** -PythonicGcodeMachine is a free and open source (*) Python toolkit to work with RS-274 / ISO G-Code. +PythonicGcodeMachine is a free and open source (*) Python toolkit to work with RS-274 / ISO G-code. .. rst-class:: small-text diff --git a/doc/sphinx/source/overview.rst b/doc/sphinx/source/overview.rst index 4c3a38b..4d8b603 100644 --- a/doc/sphinx/source/overview.rst +++ b/doc/sphinx/source/overview.rst @@ -10,23 +10,9 @@ What is PythonicGcodeMachine ? ------------------------------ -PythonicGcodeMachine is a free and open source Python toolkit to work with RS-274 / ISO G-Code. +PythonicGcodeMachine is a free and open source Python toolkit to work with RS-274 / ISO G-code. -PythonicGcodeMachine features: - -* a compliant RS-274 / ISO G-Code parser which is automatically generated from grammar and easy to - derivate to support other flavours, -* an abstract syntax tree (AST) API, -* some G-code flavour aspects are handled by YAML files for maximum flexibility, -* tools to manipulate and validate G-code, -* and more .. - -PythonicGcodeMachine supports these G-code flavours: - -* RS-274 **(full support)** -* Fanuc *(partially)* -* Heidenhain *(partially)* -* LinuxCNC *(partially)* +.. include:: features.txt How is PythonicGcodeMachine licensed ? -------------------------------------- -- GitLab