eric7/eric7_doc.py

branch
eric7
changeset 8314
e3642a6a1e71
parent 8312
800c432b34c8
child 8596
d64760b2da50
equal deleted inserted replaced
8313:dac33c7fce07 8314:e3642a6a1e71
22 22
23 import Utilities.ModuleParser 23 import Utilities.ModuleParser
24 from DocumentationTools.ModuleDocumentor import ModuleDocument 24 from DocumentationTools.ModuleDocumentor import ModuleDocument
25 from DocumentationTools.IndexGenerator import IndexGenerator 25 from DocumentationTools.IndexGenerator import IndexGenerator
26 from DocumentationTools.QtHelpGenerator import QtHelpGenerator 26 from DocumentationTools.QtHelpGenerator import QtHelpGenerator
27 from DocumentationTools.Config import eric6docDefaultColors 27 from DocumentationTools.Config import eric7docDefaultColors
28 from UI.Info import Version 28 from UI.Info import Version
29 import Utilities 29 import Utilities
30 30
31 # list of supported filename extensions 31 # list of supported filename extensions
32 supportedExtensions = [".py", ".pyw", ".ptl", ".rb"] 32 supportedExtensions = [".py", ".pyw", ".ptl", ".rb"]
37 Function to print some usage information. 37 Function to print some usage information.
38 38
39 It prints a reference of all commandline parameters that may 39 It prints a reference of all commandline parameters that may
40 be used and ends the application. 40 be used and ends the application.
41 """ 41 """
42 print("eric6_doc") 42 print("eric7_doc")
43 print() 43 print()
44 print("Copyright (c) 2003 - 2021 Detlev Offenbach" 44 print("Copyright (c) 2003 - 2021 Detlev Offenbach"
45 " <detlev@die-offenbachs.de>.") 45 " <detlev@die-offenbachs.de>.")
46 print() 46 print()
47 print("Usage:") 47 print("Usage:")
48 print() 48 print()
49 print(" eric6_doc [options] files...") 49 print(" eric7_doc [options] files...")
50 print() 50 print()
51 print("where files can be either python modules, package") 51 print("where files can be either python modules, package")
52 print("directories or ordinary directories.") 52 print("directories or ordinary directories.")
53 print() 53 print()
54 print("Options:") 54 print("Options:")
124 def version(): 124 def version():
125 """ 125 """
126 Function to show the version information. 126 Function to show the version information.
127 """ 127 """
128 print( 128 print(
129 """eric6_doc {0}\n""" 129 """eric7_doc {0}\n"""
130 """\n""" 130 """\n"""
131 """eric API documentation generator.\n""" 131 """eric API documentation generator.\n"""
132 """\n""" 132 """\n"""
133 """Copyright (c) 2003-2021 Detlev Offenbach""" 133 """Copyright (c) 2003-2021 Detlev Offenbach"""
134 """ <detlev@die-offenbachs.de>\n""" 134 """ <detlev@die-offenbachs.de>\n"""
162 "qhp-title=", "create-qhc", 162 "qhp-title=", "create-qhc",
163 ]) 163 ])
164 except getopt.error: 164 except getopt.error:
165 usage() 165 usage()
166 166
167 excludeDirs = [".svn", ".hg", ".git", ".ropeproject", ".eric6project", 167 excludeDirs = [".svn", ".hg", ".git", ".ropeproject", ".eric7project",
168 "dist", "build", "doc", "docs"] 168 "dist", "build", "doc", "docs"]
169 excludePatterns = [] 169 excludePatterns = []
170 outputDir = "doc" 170 outputDir = "doc"
171 recursive = False 171 recursive = False
172 doIndex = True 172 doIndex = True
173 noempty = False 173 noempty = False
174 newline = None 174 newline = None
175 175
176 stylesheetFile = "" 176 stylesheetFile = ""
177 colors = eric6docDefaultColors.copy() 177 colors = eric7docDefaultColors.copy()
178 178
179 qtHelpCreation = False 179 qtHelpCreation = False
180 qtHelpOutputDir = "help" 180 qtHelpOutputDir = "help"
181 qtHelpNamespace = "" 181 qtHelpNamespace = ""
182 qtHelpFolder = "source" 182 qtHelpFolder = "source"

eric ide

mercurial