Method netlist

SLiCAP/SLiCAPrst.py:33–72

Creates a LaTeX `\\input{}` or an RST '.. literalinclude:: ' command for including a netlist file. :param netlistFile: Name of the netlist file relative to the project circuit directory :type netlistFile: str :pa

(self, netlistFile, lineRange=None, firstNumber=None)

            pass

    def netlist(self, netlistFile, lineRange=None, firstNumber=None):
        """
        Creates a LaTeX `\\input{}` or an RST '.. literalinclude:: '
        command for including a netlist file.
        
        :param netlistFile: Name of the netlist file relative to the project 
                            circuit directory
        :type netlistFile: str
        
        :param lineRange: range of lines to be included
        :type lineRange: str
        
        :param firstNumber: start number of the displayed line numbers
        :type firstNumber: str
        
        :return: SLiCAP Snippet object
        :rtype: SLiCAP.SLiCAPprotos.Snippet
        
        :example:
        
        >>> import SLiCAP as sl
        >>> rst = sl.RSTformatter() # Creates a ReStructuredText formatter
        >>> rst.netlist("myFirstRCnetwork.cir").save("netlist")
        
        This will save a file `netlist.rst` in the `sl.ini.rst_snippets` folder 
        with the following contents:
        
        .. code::
        
            .. literalinclude:: <full path to myFirstRCnetwork.cir>
                :linenos:
        """
        RST = '.. literalinclude:: /' + ini.project_path 
        RST += ini.cir_path + netlistFile + '\n'
        RST += '    :linenos:\n'
        if lineRange != None:
            RST += '    :lines: ' + lineRange + '\n'
            if firstNumber != None:
                RST += '    :lineno-start: ' + str(firstNumber) + '\n'
        return Snippet(RST, self.format)
                
    def elementData(self, circuitObject, label="", caption=""):
        """