From deb49300194dbd492a74978124a68517f2834453 Mon Sep 17 00:00:00 2001 From: Fabrice Salvaire Date: Mon, 24 Dec 2018 20:30:58 +0100 Subject: [PATCH] fixed header and doc --- PythonicGcodeMachine/Gcode/Rs274/Ast.py | 2 +- PythonicGcodeMachine/Gcode/Rs274/Config.py | 2 +- PythonicGcodeMachine/Gcode/Rs274/Lexer.py | 2 +- PythonicGcodeMachine/Gcode/Rs274/Machine.py | 2 +- PythonicGcodeMachine/Gcode/Rs274/Parser.py | 2 +- PythonicGcodeMachine/Gcode/Rs274/__init__.py | 2 +- .../Gcode/Rs274/data/make-rst.py | 2 +- .../Gcode/Rs274/data/make-yaml.py | 2 +- doc/sphinx/source/conf.py | 4 ++-- doc/sphinx/source/how-to-refer.rst | 16 +++++++++------- examples/gcode/annotate-gcode.py | 2 +- examples/gcode/generate-gcode.py | 2 +- setup.py | 2 +- setup_data.py | 2 +- tools/license-model-gpl.py | 2 +- unit-test/Gcode/test_Ast.py | 2 +- unit-test/Gcode/test_Parser.py | 2 +- 17 files changed, 26 insertions(+), 24 deletions(-) diff --git a/PythonicGcodeMachine/Gcode/Rs274/Ast.py b/PythonicGcodeMachine/Gcode/Rs274/Ast.py index f333543..238ca3b 100644 --- a/PythonicGcodeMachine/Gcode/Rs274/Ast.py +++ b/PythonicGcodeMachine/Gcode/Rs274/Ast.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/PythonicGcodeMachine/Gcode/Rs274/Config.py b/PythonicGcodeMachine/Gcode/Rs274/Config.py index 0302405..3ab33de 100644 --- a/PythonicGcodeMachine/Gcode/Rs274/Config.py +++ b/PythonicGcodeMachine/Gcode/Rs274/Config.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/PythonicGcodeMachine/Gcode/Rs274/Lexer.py b/PythonicGcodeMachine/Gcode/Rs274/Lexer.py index 12c9efd..9d23f78 100644 --- a/PythonicGcodeMachine/Gcode/Rs274/Lexer.py +++ b/PythonicGcodeMachine/Gcode/Rs274/Lexer.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/PythonicGcodeMachine/Gcode/Rs274/Machine.py b/PythonicGcodeMachine/Gcode/Rs274/Machine.py index 1fadcad..940faab 100644 --- a/PythonicGcodeMachine/Gcode/Rs274/Machine.py +++ b/PythonicGcodeMachine/Gcode/Rs274/Machine.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/PythonicGcodeMachine/Gcode/Rs274/Parser.py b/PythonicGcodeMachine/Gcode/Rs274/Parser.py index fdeea7c..8d3edf8 100644 --- a/PythonicGcodeMachine/Gcode/Rs274/Parser.py +++ b/PythonicGcodeMachine/Gcode/Rs274/Parser.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/PythonicGcodeMachine/Gcode/Rs274/__init__.py b/PythonicGcodeMachine/Gcode/Rs274/__init__.py index 267b877..88bb30a 100644 --- a/PythonicGcodeMachine/Gcode/Rs274/__init__.py +++ b/PythonicGcodeMachine/Gcode/Rs274/__init__.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/PythonicGcodeMachine/Gcode/Rs274/data/make-rst.py b/PythonicGcodeMachine/Gcode/Rs274/data/make-rst.py index 3adeead..69a6fdf 100755 --- a/PythonicGcodeMachine/Gcode/Rs274/data/make-rst.py +++ b/PythonicGcodeMachine/Gcode/Rs274/data/make-rst.py @@ -2,7 +2,7 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/PythonicGcodeMachine/Gcode/Rs274/data/make-yaml.py b/PythonicGcodeMachine/Gcode/Rs274/data/make-yaml.py index f1b5eb2..cc45f18 100755 --- a/PythonicGcodeMachine/Gcode/Rs274/data/make-yaml.py +++ b/PythonicGcodeMachine/Gcode/Rs274/data/make-yaml.py @@ -2,7 +2,7 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/doc/sphinx/source/conf.py b/doc/sphinx/source/conf.py index 9698523..811bdaf 100644 --- a/doc/sphinx/source/conf.py +++ b/doc/sphinx/source/conf.py @@ -2,7 +2,7 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # #################################################################################################### @@ -313,4 +313,4 @@ intersphinx_mapping = {'http://docs.python.org/': None} # https://github.com/jdillard/sphinx-sitemap # -site_url = '@project_url@' # could use setup_dict +site_url = 'https://github.com/FabriceSalvaire/pythonic-gcode-machine' # could use setup_dict diff --git a/doc/sphinx/source/how-to-refer.rst b/doc/sphinx/source/how-to-refer.rst index b103fff..06462ee 100644 --- a/doc/sphinx/source/how-to-refer.rst +++ b/doc/sphinx/source/how-to-refer.rst @@ -1,10 +1,12 @@ +.. include:: project-links.txt + .. _how-to-refer-page: -=========================== +======================================== 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 |PythonicGcodeMachine@github| *A permanent redirection will be implemented if the domain change in the future.* @@ -17,14 +19,14 @@ A typical `BibTeX `_ citation would be, fo @software{PythonicGcodeMachine, author = {Fabrice Salvaire}, % actual author and maintainer title = {PythonicGcodeMachine}, - url = {@project_url@}, + url = {https://github.com/FabriceSalvaire/pythonic-gcode-machine}, version = {x.y}, - date = {yyyy-mm-dd}, % set to the release date + date = {2018-12-24}, % set to the release date } @Misc{PythonicGcodeMachine, author = {Fabrice Salvaire}, title = {PythonicGcodeMachine}, - howpublished = {\url{@project_url@}}, - year = {yyyy} + howpublished = {\url{https://github.com/FabriceSalvaire/pythonic-gcode-machine}}, + year = {2018} } diff --git a/examples/gcode/annotate-gcode.py b/examples/gcode/annotate-gcode.py index 12d1fbc..23a39e6 100644 --- a/examples/gcode/annotate-gcode.py +++ b/examples/gcode/annotate-gcode.py @@ -1,6 +1,6 @@ #?################################################################################################## #?# -#?# PythonicGcodeMachine - @licence_header_description@ +#?# PythonicGcodeMachine - A Python G-code Toolkit #?# Copyright (C) 2018 Fabrice Salvaire #?# #?# This program is free software: you can redistribute it and/or modify diff --git a/examples/gcode/generate-gcode.py b/examples/gcode/generate-gcode.py index 2b5743e..99afeb9 100644 --- a/examples/gcode/generate-gcode.py +++ b/examples/gcode/generate-gcode.py @@ -1,6 +1,6 @@ #?################################################################################################## #?# -#?# PythonicGcodeMachine - @licence_header_description@ +#?# PythonicGcodeMachine - A Python G-code Toolkit #?# Copyright (C) 2018 Fabrice Salvaire #?# #?# This program is free software: you can redistribute it and/or modify diff --git a/setup.py b/setup.py index cd2576d..5dbbfc9 100755 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/setup_data.py b/setup_data.py index 4bc248a..67a28b8 100644 --- a/setup_data.py +++ b/setup_data.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/tools/license-model-gpl.py b/tools/license-model-gpl.py index 680b314..d5a9ad6 100644 --- a/tools/license-model-gpl.py +++ b/tools/license-model-gpl.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/unit-test/Gcode/test_Ast.py b/unit-test/Gcode/test_Ast.py index 11a43ad..54483bf 100644 --- a/unit-test/Gcode/test_Ast.py +++ b/unit-test/Gcode/test_Ast.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify diff --git a/unit-test/Gcode/test_Parser.py b/unit-test/Gcode/test_Parser.py index 70f4f92..4e8c35d 100644 --- a/unit-test/Gcode/test_Parser.py +++ b/unit-test/Gcode/test_Parser.py @@ -1,6 +1,6 @@ #################################################################################################### # -# PythonicGcodeMachine - @licence_header_description@ +# PythonicGcodeMachine - A Python G-code Toolkit # Copyright (C) 2018 Fabrice Salvaire # # This program is free software: you can redistribute it and/or modify -- GitLab