Commit b1521227 authored by Fabrice Salvaire's avatar Fabrice Salvaire

GCode -> Gcode

parent 3af0961f
......@@ -8,7 +8,7 @@ lextab.py
parser.out
parsetab.py
PythonicGCodeMachine/PythonLexYacc/yacc.py
PythonicGcodeMachine/PythonLexYacc/yacc.py
ressources
TOFIX.txt
......
......@@ -15,7 +15,7 @@ include setup_data.py
include requirements.txt requirements-dev.txt
include .travis.yml
include bower/bower.json
recursive-include PythonicGCodeMachine *.py *.yml *py.in
recursive-include PythonicGcodeMachine *.py *.yml *py.in
recursive-include doc *
recursive-include doc/sphinx/source/_static *
recursive-include doc/sphinx/source/_templates *
......
####################################################################################################
#
# PythonicGCodeMachine - @licence_header_description@
# PythonicGcodeMachine - @licence_header_description@
# Copyright (C) 2018 Fabrice Salvaire
#
# This program is free software: you can redistribute it and/or modify
......@@ -18,7 +18,7 @@
#
####################################################################################################
__all__ = ['GCodeLexerError', 'GCodeLexer, ']
__all__ = ['GcodeLexerError', 'GcodeLexer, ']
####################################################################################################
......@@ -27,16 +27,16 @@ import re
try:
import ply.lex as lexer
except ModuleNotFoundError:
import PythonicGCodeMachine.PythonLexYacc.lex as lexer
import PythonicGcodeMachine.PythonLexYacc.lex as lexer
####################################################################################################
class GCodeLexerError(ValueError):
class GcodeLexerError(ValueError):
pass
####################################################################################################
class GCodeLexer:
class GcodeLexer:
"""Class to implement a CGode lexer.
......@@ -177,7 +177,7 @@ class GCodeLexer:
value = t.value[1:-1]
position = value.find('(')
if position != -1:
raise GCodeLexerError(t.lexpos + position +1)
raise GcodeLexerError(t.lexpos + position +1)
t.value = value
return t
......@@ -192,8 +192,8 @@ class GCodeLexer:
def t_error(self, t):
'Error handling rule'
# t.lexer.skip(1)
# raise GCodeLexerError("Illegal character @{} '{}'".format(t.lexpos, t.value))
raise GCodeLexerError(t.lexpos)
# raise GcodeLexerError("Illegal character @{} '{}'".format(t.lexpos, t.value))
raise GcodeLexerError(t.lexpos)
##############################################
......
####################################################################################################
#
# PythonicGCodeMachine - @licence_header_description@
# PythonicGcodeMachine - @licence_header_description@
# Copyright (C) 2018 Fabrice Salvaire
#
# This program is free software: you can redistribute it and/or modify
......@@ -18,23 +18,23 @@
#
####################################################################################################
__all__ = ['GCodeParserError', 'GCodeParser']
__all__ = ['GcodeParserError', 'GcodeParser']
####################################################################################################
# https://rply.readthedocs.io/en/latest/
from ply import yacc
from .Lexer import GCodeLexer, GCodeLexerError
from .Lexer import GcodeLexer, GcodeLexerError
####################################################################################################
class GCodeParserError(ValueError):
class GcodeParserError(ValueError):
pass
####################################################################################################
class GCodeParser:
class GcodeParser:
"""Class to implement a CGode parser.
......@@ -256,7 +256,7 @@ class GCodeParser:
##############################################
def p_error(self, p):
raise GCodeParserError(p.lexpos)
raise GcodeParserError(p.lexpos)
##############################################
......@@ -268,7 +268,7 @@ class GCodeParser:
def _build(self, **kwargs):
"""Build the parser"""
self._lexer = GCodeLexer()
self._lexer = GcodeLexer()
self.tokens = self._lexer.tokens
self._parser = yacc.yacc(
module=self,
......
####################################################################################################
#
# PythonicGCodeMachine - @licence_header_description@
# PythonicGcodeMachine - @licence_header_description@
# Copyright (C) 2018 Fabrice Salvaire
#
# This program is free software: you can redistribute it and/or modify
......
......@@ -4,7 +4,7 @@
.. include:: abbreviation.txt
============
PythonicGCodeMachine
PythonicGcodeMachine
============
|Pypi License|
......@@ -12,21 +12,21 @@
|Pypi Version|
* Quick Link to `Production Branch <https://github.com/FabriceSalvaire/PythonicGCodeMachine/tree/master>`_
* Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/PythonicGCodeMachine/tree/devel>`_
* Quick Link to `Production Branch <https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/master>`_
* Quick Link to `Devel Branch <https://github.com/FabriceSalvaire/PythonicGcodeMachine/tree/devel>`_
Overview
========
What is PythonicGCodeMachine ?
What is PythonicGcodeMachine ?
---------------------
PythonicGCodeMachine is a Python module which implements ...
PythonicGcodeMachine is a Python module which implements ...
Where is the Documentation ?
----------------------------
The documentation is available on the |PythonicGCodeMachineHomePage|_.
The documentation is available on the |PythonicGcodeMachineHomePage|_.
What are the main features ?
----------------------------
......
......@@ -2,14 +2,14 @@
####################################################################################################
#
# PythonicGCodeMachine - @licence_header_description@
# PythonicGcodeMachine - @licence_header_description@
# Copyright (C) 2018 Fabrice Salvaire
#
####################################################################################################
####################################################################################################
#
# PythonicGCodeMachine documentation build configuration file, created by
# PythonicGcodeMachine documentation build configuration file, created by
# sphinx-quickstart on Fri Apr 8 16:54:03 2018.
#
# This file is execfile()d with the current directory set to its containing dir.
......@@ -45,12 +45,12 @@ logger = logging.getLogger(__name__)
# documentation root, use os.path.abspath to make it absolute, like shown here.
# for directory in ,:
PythonicGCodeMachine_path = os.path.abspath(os.path.join(__file__, *['..']*4))
sys.path.insert(0, PythonicGCodeMachine_path)
PythonicGcodeMachine_path = os.path.abspath(os.path.join(__file__, *['..']*4))
sys.path.insert(0, PythonicGcodeMachine_path)
####################################################################################################
exec(compile(open(os.path.join(PythonicGCodeMachine_path, 'setup_data.py')).read(), 'setup_data.py', 'exec'))
exec(compile(open(os.path.join(PythonicGcodeMachine_path, 'setup_data.py')).read(), 'setup_data.py', 'exec'))
####################################################################################################
#
......@@ -88,7 +88,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = 'PythonicGCodeMachine'
project = 'PythonicGcodeMachine'
copyright = '{0.year}, Fabrice Salvaire'.format(datetime.now())
# The version info for the project you're documenting, acts as replacement for
......@@ -157,8 +157,8 @@ autodoc_default_flags = [
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#html_theme = 'PythonicGCodeMachine'
html_theme = 'PythonicGCodeMachineRtd'
#html_theme = 'PythonicGcodeMachine'
html_theme = 'PythonicGcodeMachineRtd'
# html_theme = 'sphinx_rtd_theme'
# on_rtd is whether we are on readthedocs.org
......@@ -241,7 +241,7 @@ html_static_path = ['_static']
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'PythonicGCodeMachine'
htmlhelp_basename = 'PythonicGcodeMachine'
####################################################################################################
#
......@@ -259,7 +259,7 @@ latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'PythonicGCodeMachine.tex', 'PythonicGCodeMachine Documentation', 'Fabrice Salvaire', 'manual'),
('index', 'PythonicGcodeMachine.tex', 'PythonicGcodeMachine Documentation', 'Fabrice Salvaire', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
......@@ -293,7 +293,7 @@ latex_logo = None
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'PythonicGCodeMachine', 'PythonicGCodeMachine Documentation', ['Fabrice Salvaire'], 1)
('index', 'PythonicGcodeMachine', 'PythonicGcodeMachine Documentation', ['Fabrice Salvaire'], 1)
]
# Example configuration for intersphinx: refer to the Python standard library.
......
......@@ -4,11 +4,11 @@
Development & Community
=========================
PythonicGCodeMachine is an open-source project, and relies on its community of users to keep getting better.
PythonicGcodeMachine is an open-source project, and relies on its community of users to keep getting better.
PythonicGCodeMachine source code and issues are managed on `Github <https://github.com/FabriceSalvaire/PythonicGCodeMachine>`_.
PythonicGcodeMachine source code and issues are managed on `Github <https://github.com/FabriceSalvaire/PythonicGcodeMachine>`_.
**Note to Packagers: Please don't create PythonicGCodeMachine package (PiPY do the job)**
**Note to Packagers: Please don't create PythonicGcodeMachine package (PiPY do the job)**
How you can help ?
------------------
......@@ -18,9 +18,9 @@ As an open source project, anyone is welcome to contribute in whatever form they
.. , which can include taking part in discussions, filing bug reports, proposing improvements,
contributing code or documentation, and testing it.
* Promote PythonicGCodeMachine on the web and all around you
* Promote PythonicGcodeMachine on the web and all around you
* Fill bug reports
* Test PythonicGCodeMachine on Linux, Windows and OS X
* Test PythonicGcodeMachine on Linux, Windows and OS X
* Check for errors on the documentation
* Propose improvements
* Implement missing features
......@@ -29,4 +29,4 @@ As an open source project, anyone is welcome to contribute in whatever form they
Contributors
------------
The list of contributors is available at https://github.com/FabriceSalvaire/PythonicGCodeMachine/graphs/contributors
The list of contributors is available at https://github.com/FabriceSalvaire/PythonicGcodeMachine/graphs/contributors
......@@ -4,7 +4,7 @@
How to Help Further ?
=======================
If you like PythonicGCodeMachine, you can donate for its developement to my `PayPal account
If you like PythonicGcodeMachine, you can donate for its developement to my `PayPal account
<https://www.paypal.me/FabriceSalvaire>`_.
This budget could help me to mainly finance a domain, a vps to host a site, a forum (*) and also to
......
......@@ -12,19 +12,19 @@ How to get help or report an issue ?
.. There is no mailing list or forum actually, so you can either contact me or fill an issue on Github.
If you want to **discuss or ask questions on PythonicGCodeMachine**, you can subscribe and post messages on the
**PythonicGCodeMachine User** mailing list.
If you want to **discuss or ask questions on PythonicGcodeMachine**, you can subscribe and post messages on the
**PythonicGcodeMachine User** mailing list.
There is actually three lists running on Google Groups (*):
`User List <https://groups.google.com/forum/#!forum/PythonicGCodeMachine-user>`_
List for PythonicGCodeMachine users
`Announce List <https://groups.google.com/forum/#!forum/PythonicGCodeMachine-announce>`_
List for announcements regarding PythonicGCodeMachine releases and development
`Devel List <https://groups.google.com/forum/#!forum/PythonicGCodeMachine-devel>`_
List for developers of PythonicGCodeMachine
`User List <https://groups.google.com/forum/#!forum/PythonicGcodeMachine-user>`_
List for PythonicGcodeMachine users
`Announce List <https://groups.google.com/forum/#!forum/PythonicGcodeMachine-announce>`_
List for announcements regarding PythonicGcodeMachine releases and development
`Devel List <https://groups.google.com/forum/#!forum/PythonicGcodeMachine-devel>`_
List for developers of PythonicGcodeMachine
**If you encounter an issue, please fill an issue** on the `Issue Tracker <https://github.com/FabriceSalvaire/PythonicGCodeMachine/issues>`_.
**If you encounter an issue, please fill an issue** on the `Issue Tracker <https://github.com/FabriceSalvaire/PythonicGcodeMachine/issues>`_.
(*) Despite Google Groups has many drawbacks, I don't have actually enough resources to run GNU Mailman or
Discourse on my own IT infrastructure.
.. _how-to-refer-page:
===========================
How to Refer to PythonicGCodeMachine ?
How to Refer to PythonicGcodeMachine ?
===========================
Up to now, the official url for PythonicGCodeMachine is @project_url@
Up to now, the official url for PythonicGcodeMachine is @project_url@
*A permanent redirection will be implemented if the domain change in the future.*
On Github, you can use the **PythonicGCodeMachine** `topic <https://github.com/search?q=topic%3APythonicGCodeMachine&type=Repositories>`_ for repository related to PythonicGCodeMachine.
On Github, you can use the **PythonicGcodeMachine** `topic <https://github.com/search?q=topic%3APythonicGcodeMachine&type=Repositories>`_ for repository related to PythonicGcodeMachine.
A typical `BibTeX <https://en.wikipedia.org/wiki/BibTeX>`_ citation would be, for example:
.. code:: bibtex
@software{PythonicGCodeMachine,
@software{PythonicGcodeMachine,
author = {Fabrice Salvaire}, % actual author and maintainer
title = {PythonicGCodeMachine},
title = {PythonicGcodeMachine},
url = {@project_url@},
version = {x.y},
date = {yyyy-mm-dd}, % set to the release date
}
@Misc{PythonicGCodeMachine,
@Misc{PythonicGcodeMachine,
author = {Fabrice Salvaire},
title = {PythonicGCodeMachine},
title = {PythonicGcodeMachine},
howpublished = {\url{@project_url@}},
year = {yyyy}
}
......@@ -42,7 +42,7 @@
########
.. image:: /_static/logo.png
:alt: PythonicGCodeMachine logo
:alt: PythonicGcodeMachine logo
:width: 750
.. important::
......@@ -52,15 +52,15 @@
Overview
********
PythonicGCodeMachine is a free and open source (*) Python module which interface |Python|_ ...
PythonicGcodeMachine is a free and open source (*) Python module which interface |Python|_ ...
.. rst-class:: small-text
(*) PythonicGCodeMachine is licensed under GPLv3 therms.
(*) PythonicGcodeMachine is licensed under GPLv3 therms.
PythonicGCodeMachine requires Python 3 and works on Linux, Windows and OS X.
PythonicGcodeMachine requires Python 3 and works on Linux, Windows and OS X.
:ref:`To read more on PythonicGCodeMachine <overview-page>`
:ref:`To read more on PythonicGcodeMachine <overview-page>`
.. raw:: html
......@@ -80,7 +80,7 @@ What's changed in versions
:ref:`Installation-page`
========================
How to install PythonicGCodeMachine on your system
How to install PythonicGcodeMachine on your system
.. rst-class:: column column2
......@@ -94,7 +94,7 @@ Answers to frequent questions
:ref:`examples-page`
====================
Many examples to learn how to use PythonicGCodeMachine.
Many examples to learn how to use PythonicGcodeMachine.
.. rst-class:: column column2
......@@ -115,7 +115,7 @@ Technical reference material, for classes, methods, APIs, commands.
:ref:`how-to-refer-page`
========================
Guidelines to cite PythonicGCodeMachine
Guidelines to cite PythonicGcodeMachine
.. rst-class:: column column2
......
......@@ -7,7 +7,7 @@
Installation
==============
**Note to Packagers: Please don't create PythonicGCodeMachine package (PiPY do the job)**
**Note to Packagers: Please don't create PythonicGcodeMachine package (PiPY do the job)**
On Windows
----------
......@@ -17,18 +17,18 @@ as to get a full featured Python 3 environment.
Then open the `Anaconda Navigator <https://docs.continuum.io/anaconda/navigator/>`_ and launch a console for your root environment.
You can now run *pip* to install PythonicGCodeMachine in your root environment using this command:
You can now run *pip* to install PythonicGcodeMachine in your root environment using this command:
.. code-block:: sh
pip install PythonicGCodeMachine
pip install PythonicGcodeMachine
On Linux
--------
Firstly, you have to install Python 3 from your distribution.
Then you can install PythonicGCodeMachine using *pip* or from source. See supra.
Then you can install PythonicGcodeMachine using *pip* or from source. See supra.
On OSX
------
......@@ -40,18 +40,18 @@ There are several ways to get Python on OSX:
* install the `Anaconda Distribution <https://www.anaconda.com/download/>`_.
* install from Brew `brew install python3` **(reported to work)**
You can install PythonicGCodeMachine using *pip* or from source. See supra.
You can install PythonicGcodeMachine using *pip* or from source. See supra.
Installation from PyPi Repository
---------------------------------
PythonicGCodeMachine is available on the Python Packages |Pypi|_ repository at |PythonicGCodeMachine@pypi|
PythonicGcodeMachine is available on the Python Packages |Pypi|_ repository at |PythonicGcodeMachine@pypi|
Run this command in the console to install the latest release:
.. code-block:: sh
pip install PythonicGCodeMachine
pip install PythonicGcodeMachine
Install a more recent version from Github
-----------------------------------------
......@@ -61,28 +61,28 @@ commands to install the stable or devel branch:
.. code-block:: sh
pip install git+https://github.com/FabriceSalvaire/PythonicGCodeMachine
pip install git+https://github.com/FabriceSalvaire/PythonicGcodeMachine
pip install git+https://github.com/FabriceSalvaire/PythonicGCodeMachine@devel
pip install git+https://github.com/FabriceSalvaire/PythonicGcodeMachine@devel
Installation from Source
------------------------
The PythonicGCodeMachine source code is hosted at |PythonicGCodeMachine@github|
The PythonicGcodeMachine source code is hosted at |PythonicGcodeMachine@github|
.. add link to pages ...
You have to solution to get the source code, the first one is to clone the repository, but if you
are not familiar with Git then you can simply download an archive either from the PythonicGCodeMachine Pypi page
are not familiar with Git then you can simply download an archive either from the PythonicGcodeMachine Pypi page
(at the bottom) or the GitHub page (see clone or download button).
To clone the Git repository, run this command in a console:
.. code-block:: sh
git clone https://github.com/FabriceSalvaire/PythonicGCodeMachine.git
git clone https://github.com/FabriceSalvaire/PythonicGcodeMachine.git
Then to build and install PythonicGCodeMachine run these commands:
Then to build and install PythonicGcodeMachine run these commands:
.. code-block:: sh
......@@ -92,7 +92,7 @@ Then to build and install PythonicGCodeMachine run these commands:
Dependencies
------------
PythonicGCodeMachine requires the following dependencies:
PythonicGcodeMachine requires the following dependencies:
* |Python|_ 3
* |Numpy|_
......
......@@ -7,36 +7,36 @@
Overview
==========
What is PythonicGCodeMachine ?
What is PythonicGcodeMachine ?
---------------------
PythonicGCodeMachine is an open source Python module which provides a |Python|_ ....
PythonicGcodeMachine is an open source Python module which provides a |Python|_ ....
How is PythonicGCodeMachine licensed ?
How is PythonicGcodeMachine licensed ?
-----------------------------
PythonicGCodeMachine is licensed under the `GPLv3 <https://www.gnu.org/licenses/quick-guide-gplv3.en.html>`_.
PythonicGcodeMachine is licensed under the `GPLv3 <https://www.gnu.org/licenses/quick-guide-gplv3.en.html>`_.
Going further with PythonicGCodeMachine
Going further with PythonicGcodeMachine
------------------------------
The best way to know what you can do with PythonicGCodeMachine, and to learn it, is to look at the examples:
The best way to know what you can do with PythonicGcodeMachine, and to learn it, is to look at the examples:
* :ref:`PythonicGCodeMachine Reference Manual <reference-manual-page>`
* :ref:`PythonicGcodeMachine Reference Manual <reference-manual-page>`
* :ref:`Bibliography <bibliography-page>`
Which platforms are supported by PythonicGCodeMachine ?
Which platforms are supported by PythonicGcodeMachine ?
----------------------------------------------
PythonicGCodeMachine runs on Linux, Windows 64-bit and Mac OS X.
PythonicGcodeMachine runs on Linux, Windows 64-bit and Mac OS X.
How to install PythonicGCodeMachine ?
How to install PythonicGcodeMachine ?
----------------------------
The procedure to install PythonicGCodeMachine is described in the :ref:`Installation Manual <installation-page>`.
The procedure to install PythonicGcodeMachine is described in the :ref:`Installation Manual <installation-page>`.
Which version of Python is required ?
-------------------------------------
PythonicGCodeMachine requires Python 3 and the version 3.5 is recommended so as to benefit from the new *@* syntax
PythonicGcodeMachine requires Python 3 and the version 3.5 is recommended so as to benefit from the new *@* syntax
for units.
.. -*- Mode: rst -*-
..
|PythonicGCodeMachineUrl|
|PythonicGCodeMachineHomePage|_
|PythonicGCodeMachineDoc|_
|PythonicGCodeMachine@github|_
|PythonicGCodeMachine@readthedocs|_
|PythonicGCodeMachine@readthedocs-badge|
|PythonicGCodeMachine@pypi|_
|PythonicGcodeMachineUrl|
|PythonicGcodeMachineHomePage|_
|PythonicGcodeMachineDoc|_
|PythonicGcodeMachine@github|_
|PythonicGcodeMachine@readthedocs|_
|PythonicGcodeMachine@readthedocs-badge|
|PythonicGcodeMachine@pypi|_
.. |ohloh| image:: https://www.openhub.net/accounts/230426/widgets/account_tiny.gif
:target: https://www.openhub.net/accounts/fabricesalvaire
......@@ -15,35 +15,35 @@
:height: 15px
:width: 80px
.. |PythonicGCodeMachineUrl| replace:: @project_url@
.. |PythonicGcodeMachineUrl| replace:: @project_url@
.. |PythonicGCodeMachineHomePage| replace:: PythonicGCodeMachine Home Page
.. _PythonicGCodeMachineHomePage: @project_url@
.. |PythonicGcodeMachineHomePage| replace:: PythonicGcodeMachine Home Page
.. _PythonicGcodeMachineHomePage: @project_url@
.. |PythonicGCodeMachine@readthedocs-badge| image:: https://readthedocs.org/projects/PythonicGCodeMachine/badge/?version=latest
:target: http://PythonicGCodeMachine.readthedocs.org/en/latest
.. |PythonicGcodeMachine@readthedocs-badge| image:: https://readthedocs.org/projects/PythonicGcodeMachine/badge/?version=latest
:target: http://PythonicGcodeMachine.readthedocs.org/en/latest
.. |PythonicGCodeMachine@github| replace:: https://github.com/FabriceSalvaire/PythonicGCodeMachine
.. .. _PythonicGCodeMachine@github: https://github.com/FabriceSalvaire/PythonicGCodeMachine
.. |PythonicGcodeMachine@github| replace:: https://github.com/FabriceSalvaire/PythonicGcodeMachine
.. .. _PythonicGcodeMachine@github: https://github.com/FabriceSalvaire/PythonicGcodeMachine
.. |PythonicGCodeMachine@pypi| replace:: https://pypi.python.org/pypi/PythonicGCodeMachine
.. .. _PythonicGCodeMachine@pypi: https://pypi.python.org/pypi/PythonicGCodeMachine
.. |PythonicGcodeMachine@pypi| replace:: https://pypi.python.org/pypi/PythonicGcodeMachine
.. .. _PythonicGcodeMachine@pypi: https://pypi.python.org/pypi/PythonicGcodeMachine
.. |Build Status| image:: https://travis-ci.org/FabriceSalvaire/PythonicGCodeMachine.svg?branch=master
:target: https://travis-ci.org/FabriceSalvaire/PythonicGCodeMachine
:alt: PythonicGCodeMachine build status @travis-ci.org
.. |Build Status| image:: https://travis-ci.org/FabriceSalvaire/PythonicGcodeMachine.svg?branch=master
:target: https://travis-ci.org/FabriceSalvaire/PythonicGcodeMachine
:alt: PythonicGcodeMachine build status @travis-ci.org
.. |Pypi Version| image:: https://img.shields.io/pypi/v/PythonicGCodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGCodeMachine
:alt: PythonicGCodeMachine last version
.. |Pypi Version| image:: https://img.shields.io/pypi/v/PythonicGcodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGcodeMachine
:alt: PythonicGcodeMachine last version
.. |Pypi License| image:: https://img.shields.io/pypi/l/PythonicGCodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGCodeMachine
:alt: PythonicGCodeMachine license
.. |Pypi License| image:: https://img.shields.io/pypi/l/PythonicGcodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGcodeMachine
:alt: PythonicGcodeMachine license
.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/PythonicGCodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGCodeMachine
:alt: PythonicGCodeMachine python version
.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/PythonicGcodeMachine.svg
:target: https://pypi.python.org/pypi/PythonicGcodeMachine
:alt: PythonicGcodeMachine python version
.. coverage test
.. https://img.shields.io/pypi/status/Django.svg
......
......@@ -6,7 +6,7 @@
API Documentation
===================
This is the API documentation for the PythonicGCodeMachine library.
This is the API documentation for the PythonicGcodeMachine library.
.. warning:: The API documentation is automatically generated from the docstrings in the source
using the |Sphinx| tool. This way to produce the documentation is know to be perfectible
......@@ -17,7 +17,7 @@ Contents:
.. toctree::
:maxdepth: 2
api/PythonicGCodeMachine
api/PythonicGcodeMachine
Indexes
-------
......
......@@ -7,4 +7,4 @@
Roadmap
=========
`Roadmap @Github <https://github.com/FabriceSalvaire/PythonicGCodeMachine/milestones>`_
`Roadmap @Github <https://github.com/FabriceSalvaire/PythonicGcodeMachine/milestones>`_
......@@ -2,11 +2,11 @@
/* ----------------------------------------------------------------------------------------------- *
*
* PythonicGCodeMachine stylesheet
* PythonicGcodeMachine stylesheet
*
* :copyright: Copyright 2017 Fabrice Salvaire
*
* This file is part of the PythonicGCodeMachine software.
* This file is part of the PythonicGcodeMachine software.
*
*/
......
[theme]
inherit = sphinx_rtd_theme
stylesheet = css/PythonicGCodeMachine.css
stylesheet = css/PythonicGcodeMachine.css
# pygments_style = sphinx
[options]
......
This branch contains the GitHub Pages for PythonicGCodeMachine.
This branch contains the GitHub Pages for PythonicGcodeMachine.
These pages are generated by the documentation tool.
......@@ -9,7 +9,7 @@ source_gh_pages=${root_dir}/gh-pages
echo Source Path: ${root_dir}
echo HTML Build Path: ${html_build}
origin='git@github.com:FabriceSalvaire/PythonicGCodeMachine.git'
origin='git@github.com:FabriceSalvaire/PythonicGcodeMachine.git'
####################################################################################################
......@@ -18,13 +18,13 @@ if [ -e ${tmp_dir} ]; then
pushd ${tmp_dir}
# To create gh-pages branch
# git clone ${origin} PythonicGCodeMachine-gh-pages
# pushd PythonicGCodeMachine-gh-pages
# git clone ${origin} PythonicGcodeMachine-gh-pages
# pushd PythonicGcodeMachine-gh-pages
# git checkout --orphan gh-pages
# git rm --cached -r .
git clone ${origin} PythonicGCodeMachine-gh-pages --branch gh-pages --single-branch
pushd PythonicGCodeMachine-gh-pages
git clone ${origin} PythonicGcodeMachine-gh-pages --branch gh-pages --single-branch
pushd PythonicGcodeMachine-gh-pages
# sync with origin if already cloned
# git fetch origin
git checkout gh-pages
......
......@@ -2,7 +2,7 @@
####################################################################################################
#
# PythonicGCodeMachine - @licence_header_description@
# PythonicGcodeMachine - @licence_header_description@
# Copyright (C) 2018 Fabrice Salvaire
#