Exemplo n.º 1
0
    def get_mqtt_doc(self):
        doc = common.make_rst_header(self, False)
        doc += common.make_rst_summary(self)
        doc += self.get_mqtt_examples()
        doc += self.get_mqtt_api()

        return doc
Exemplo n.º 2
0
    def get_shell_doc(self):
        doc  = common.make_rst_header(self, has_device_identifier_constant=False)
        doc += common.make_rst_summary(self)
        doc += self.get_shell_examples()
        doc += self.get_shell_api()

        return doc
    def get_tcpip_doc(self):
        doc = common.make_rst_header(self,
                                     has_device_identifier_constant=False)
        doc += common.make_rst_summary(self, is_programming_language=False)
        doc += self.get_tcpip_api()

        return doc
Exemplo n.º 4
0
    def get_javascript_doc(self):
        doc  = common.make_rst_header(self)
        doc += common.make_rst_summary(self)
        doc += self.get_javascript_examples()
        doc += self.get_javascript_api()

        return doc
Exemplo n.º 5
0
    def get_mqtt_doc(self):
        doc  = common.make_rst_header(self, False)
        doc += common.make_rst_summary(self)
        doc += self.get_mqtt_examples()
        doc += self.get_mqtt_api()

        return doc
    def get_javascript_doc(self):
        doc = common.make_rst_header(self)
        doc += common.make_rst_summary(self)
        doc += self.get_javascript_examples()
        doc += self.get_javascript_api()

        return doc
Exemplo n.º 7
0
    def get_perl_doc(self):
        doc  = common.make_rst_header(self)
        doc += common.make_rst_summary(self)
        doc += self.get_perl_examples()
        doc += self.get_perl_api()

        return doc
    def get_mathematica_doc(self):
        doc  = common.make_rst_header(self)
        doc += common.make_rst_summary(self)
        doc += self.get_mathematica_examples()
        doc += self.get_mathematica_api()

        return doc
Exemplo n.º 9
0
    def get_shell_doc(self):
        doc  = common.make_rst_header(self, has_device_identifier_constant=False)
        doc += common.make_rst_summary(self)
        doc += self.get_shell_examples()
        doc += self.get_shell_api()

        return doc
Exemplo n.º 10
0
    def get_mathematica_doc(self):
        doc  = common.make_rst_header(self)
        doc += common.make_rst_summary(self)
        doc += self.get_mathematica_examples()
        doc += self.get_mathematica_api()

        return doc
Exemplo n.º 11
0
    def get_php_doc(self):
        title = { 'en': 'PHP bindings', 'de': 'PHP Bindings' }

        doc  = common.make_rst_header(self, 'PHP')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_php_examples()
        doc += self.get_php_api()

        return doc
Exemplo n.º 12
0
    def get_ruby_doc(self):
        title = { 'en': 'Ruby bindings', 'de': 'Ruby Bindings' }

        doc  = common.make_rst_header(self, 'Ruby')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_ruby_examples()
        doc += self.get_ruby_api()

        return doc
Exemplo n.º 13
0
    def get_delphi_doc(self):
        title = { 'en': 'Delphi bindings', 'de': 'Delphi Bindings' }

        doc  = common.make_rst_header(self, 'Delphi')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_delphi_examples()
        doc += self.get_delphi_api()

        return doc
Exemplo n.º 14
0
    def get_javascript_doc(self):
        title = { 'en': 'JavaScript bindings', 'de': 'JavaScript Bindings' }

        doc  = common.make_rst_header(self, 'JavaScript')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_javascript_examples()
        doc += self.get_javascript_api()

        return doc
Exemplo n.º 15
0
    def get_labview_doc(self):
        title = { 'en': 'LabVIEW bindings', 'de': 'LabVIEW Bindings' }

        doc  = common.make_rst_header(self, 'LabVIEW')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_labview_examples()
        doc += self.get_labview_api()

        return doc
Exemplo n.º 16
0
    def get_c_doc(self):
        title = { 'en': 'C/C++ bindings', 'de': 'C/C++ Bindings' }

        doc  = common.make_rst_header(self, 'C/C++')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_c_examples()
        doc += self.get_c_api()

        return doc
Exemplo n.º 17
0
    def get_vbnet_doc(self):
        title = { 'en': 'Visual Basic .NET bindings', 'de': 'Visual Basic .NET Bindings' }

        doc  = common.make_rst_header(self, 'Visual Basic .NET')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_vbnet_examples()
        doc += self.get_vbnet_api()

        return doc
Exemplo n.º 18
0
    def get_mathematica_doc(self):
        title = { 'en': 'Mathematica bindings', 'de': 'Mathematica Bindings' }

        doc  = common.make_rst_header(self, 'Mathematica')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_mathematica_examples()
        doc += self.get_mathematica_api()

        return doc
Exemplo n.º 19
0
    def get_matlab_doc(self):
        title = { 'en': 'MATLAB bindings', 'de': 'MATLAB Bindings' }

        doc  = common.make_rst_header(self, 'MATLAB')
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_matlab_examples()
        doc += self.get_matlab_api()

        return doc
Exemplo n.º 20
0
    def get_shell_doc(self):
        title = { 'en': 'Shell bindings', 'de': 'Shell Bindings' }

        doc  = common.make_rst_header(self, 'Shell', has_device_identifier_constant=False)
        doc += common.make_rst_summary(self, common.select_lang(title))
        doc += self.get_shell_examples()
        doc += self.get_shell_api()

        return doc
Exemplo n.º 21
0
def make_files(com_new, directory):
    global device
    device = common.Device(com_new)
    file_name = "{0}_{1}_Java".format(device.get_camel_case_name(), device.get_category())
    title = {"en": "Java bindings", "de": "Java Bindings"}
    directory = os.path.join(directory, "doc", common.lang)
    f = file("{0}/{1}.rst".format(directory, file_name), "w")
    f.write(common.make_rst_header(device, "java", "Java"))
    f.write(common.make_rst_summary(device, common.select_lang(title)))
    f.write(make_examples())
    f.write(make_api())
Exemplo n.º 22
0
    def get_rust_doc(self):
        docs_rs = {'en': 'Additional documentation can be found on `docs.rs <https://docs.rs/tinkerforge/latest/tinkerforge/{device_name_under}/index.html>`_.\n',
                   'de': 'Zusätzliche Dokumentation findet sich auf `docs.rs <https://docs.rs/tinkerforge/latest/tinkerforge/{device_name_under}/index.html>`_.\n'}

        doc  = common.make_rst_header(self)
        doc += common.make_rst_summary(self)
        doc += common.select_lang(docs_rs).format(device_name_under=self.get_name().under + "_" + self.get_category().under)
        doc += self.get_rust_examples()
        doc += self.get_rust_api()

        return doc
Exemplo n.º 23
0
    def get_rust_doc(self):
        docs_rs = {'en': 'Additional documentation can be found on `docs.rs <https://docs.rs/tinkerforge/latest/tinkerforge/{module_name}/index.html>`_.\n',
                   'de': 'Zusätzliche Dokumentation findet sich auf `docs.rs <https://docs.rs/tinkerforge/latest/tinkerforge/{module_name}/index.html>`_.\n'}

        doc  = common.make_rst_header(self)
        doc += common.make_rst_summary(self)
        doc += common.select_lang(docs_rs).format(module_name=self.get_rust_module_name())
        doc += self.get_rust_examples()
        doc += self.get_rust_api()

        return doc
def make_files(com_new, directory):
    global device
    device = common.Device(com_new)
    file_name = '{0}_{1}_TCPIP'.format(device.get_camel_case_name(), device.get_category())
    title = {
    'en': 'TCP/IP protocol',
    'de': 'TCP/IP Protokoll'
    }
    directory = os.path.join(directory, 'doc', common.lang)
    f = file('{0}/{1}.rst'.format(directory, file_name), "w")
    f.write(common.make_rst_header(device, 'tcpip', 'TCP/IP'))
    f.write(common.make_rst_summary(device, common.select_lang(title)))
    f.write(make_api())
Exemplo n.º 25
0
def make_files(com_new, directory):
    global device
    device = common.Device(com_new)
    file_name = "{0}_{1}_TCPIP".format(device.get_camel_case_name(), device.get_category())
    title = {"en": "TCP/IP protocol", "de": "TCP/IP Protokoll"}

    directory += "/doc"
    if not os.path.exists(directory):
        os.makedirs(directory)

    f = file("{0}/{1}.rst".format(directory, file_name), "w")
    f.write(common.make_rst_header(device, "tcpip", "TCP/IP"))
    f.write(common.make_rst_summary(device, title[lang]))
    f.write(make_api())
Exemplo n.º 26
0
def make_files(com_new, directory):
    global device
    device = common.Device(com_new)
    file_name = '{0}_{1}_Python'.format(device.get_camel_case_name(), device.get_category())
    title = {
    'en': 'Python bindings',
    'de': 'Python Bindings'
    }
    directory = os.path.join(directory, 'doc', common.lang)
    f = file('{0}/{1}.rst'.format(directory, file_name), "w")
    f.write(common.make_rst_header(device, 'python', 'Python'))
    f.write(common.make_rst_summary(device, common.select_lang(title)))
    f.write(make_examples())
    f.write(make_api())
Exemplo n.º 27
0
    def get_go_doc(self):
        docs_rs = {
            'en':
            'Additional documentation can be found on `godoc.org <https://godoc.org/github.com/Tinkerforge/go-api-bindings/{device_name_under}>`_.\n',
            'de':
            'Zusätzliche Dokumentation findet sich auf `godoc.org <https://godoc.org/github.com/Tinkerforge/go-api-bindings/{device_name_under}>`_.\n'
        }

        doc = common.make_rst_header(self)
        doc += common.make_rst_summary(self)
        doc += common.select_lang(docs_rs).format(
            device_name_under=self.get_go_package())
        doc += self.get_go_examples()
        doc += self.get_go_api()

        return doc
Exemplo n.º 28
0
def make_files(com_new, directory):
    global device
    device = common.Device(com_new)
    file_name = '{0}_{1}_Modbus'.format(device.get_camel_case_name(), device.get_category())
    title = {
    'en': 'Modbus protocol',
    'de': 'Modbus Protokoll'
    }

    directory += '/doc'
    if not os.path.exists(directory):
        os.makedirs(directory)

    f = file('{0}/{1}.rst'.format(directory, file_name), "w")
    f.write(common.make_rst_header(device, 'modbus', 'Modbus'))
    f.write(common.make_rst_summary(device, title[lang]))
    f.write(make_api())
Exemplo n.º 29
0
def make_files(com_new, directory):
    global device
    device = common.Device(com_new)
    file_name = '{0}_{1}_Python'.format(device.get_camel_case_name(), device.get_category())
    title = {
    'en': 'Python bindings',
    'de': 'Python Bindings'
    }

    directory += '/doc'
    if not os.path.exists(directory):
        os.makedirs(directory)

    f = file('{0}/{1}.rst'.format(directory, file_name), "w")
    f.write(common.make_rst_header(device, 'python', 'Python'))
    f.write(common.make_rst_summary(device, title[lang]))
    f.write(make_examples())
    f.write(make_api())

    copy_examples_for_zip()
Exemplo n.º 30
0
    def get_tcpip_doc(self):
        doc  = common.make_rst_header(self, has_device_identifier_constant=False)
        doc += common.make_rst_summary(self, is_programming_language=False)
        doc += self.get_tcpip_api()

        return doc