7.15. setup.conf

Configuration parameters for the commands provided by setupdocx refer to:

The configuration data is used as static default values for the assigned command or metadata. The evaluation is processed in the order with the falling priority:

  1. command line parameters

  2. setup.conf config

  3. default values from the derived class provided by the member docx_defaults.

  4. hard coded final defaults

Be aware that some parameters are combined for resulting parameter values. When these are set static the values are used, and further evaluation is suppressed.

For additional information refer to distutils [distutils].

  • metadata

    The section [metadata] contains the parameters supported by the classes derived from distutils.dist.Distribution. This comprises common data and global options of the setup call within setup.py. See [distutils].

  • build_docx

    The section [build_docx] provides default values for static parameters used by build_docx. See build_docx.

  • dist_docx

    The section [dist_docx] provides default values for static parameters used by dist_docx. See dist_docx.

  • install_docx

    The section [dist_docx] provides default values for static parameters used by install_docx. See install_docx.

  • build_apidoc

    The section [build_apidoc] provides default values for static parameters used by build_apidoc. See build_apidoc.

  • build_apiref

    The section [build_apiref] provides default values for static parameters used by build_apiref. See build_apiref.

7.15.1. Source

The setup.conf provides static default values for command line options. Be aware, that the most of the values are assigned dynamic at runtime. This in particular comprises the combination of multiple entries, which is omitted in case of provided configuration values. The use of these values has to be considered thoroughly. See [distutils].

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497

[build_docx]
#
# the static configuration options, these serve as defaults when the corresponding
# command line option is present 
#

# activates --apiref  
# apiref = 


# default: search(<conf-dir>, <configdir>, <docsrc>/conf)/call_apidoc.sh
# build-apidoc =  


# default:search(<conf-dir>, <configdir>, <docsrc>/conf)/call_apiref.sh
# build_apiref = 


# default:search(<conf-dir>, <configdir>, <docsrc>/conf)/call_doc.sh
# build_doc = 


# root of the build directory
# build_dir = build/


# cleans old output
# clean = False


# configuration directory
# conf_dir = <docsource>/conf/


# attribute of derived class <<self.name>>
# docname = setupdocx


# document source
# docsource = docsrc/


# created document type
# see --help-doctypes
# doctype = html


# top index file to be used as replacement for the document
# indexsrc = docsrc/index.rst


# attribute of derived class <<self.name>>
# name = setupdocx


# <year>.<month>.<day>
# release = test-release 


# path list of source directories to be processed by call_apidoc.sh and call_apiref.sh
# the syntax is a semicolon separated list, e.g.:
#
#   srcdir = setupdocx;bin
#
# srcdir = setupdocx;bin;utilities


# the document version
# version =  

# optonal coyright text, default: (C) <year> <author>
# copyright =


[install_docx]
#
# installs form a directory - by default 
#

# package name, changes <<self.name>> of the instance of install_docx
# resulting in the created document <build-dir>/apidoc/<name-or-docname>
# name = <<self.name>>


# installation source tree
# build-dir = build/


# document name, could be different from --name,
# used as the input and the output name of the document
# resulting in the created document <build-dir>/apidoc/<name-or-docname>
# docname = <self.name> 


# installation target directory, PEP-370, user data directory
# dist-dir = /user/data/ + doc/en/html/man3


# document type to install
# see --help-doctypes
# doctype = html 


# print only, do not execute
# no-exec = 0


# debug flag, higher numbers raise level
# debug = 0


# verbose flag, higher numbers raise level
# verbose = 0


[dist_docx]

# append files to existing archive, default: create new
# can be used to add new unpack-dir
# append = 


# document source location
# build-dir = build/


# debug flag
# debug = 0


# document type to pack
# see --help-doctypes
# doctype = html


# type of the created package
# see --help-formats
# format = zip


# changes package name
# name = <self.name>


# input package name
# name-in = <self.name>


# output package name
# name-out = <self.name>


# sets version of created archive, else date
# set-version = <year>.<month>.<day>


# archive location for creation
# dist-dir = dist/


#
# name of prefix directory to unpack to, also archive prefix,
# relative subdirectories only,
#
#   self.release = <self.name>-doc-<self.doctype>-<self.version>
#
# for example setupdocx-doc-html-20190501
#
# unpack-dir = self.release



[build_apiref]
#
# the static configuration options, these serve as defaults when the corresponding
# command line option is present 
#

# default:search(<conf-dir>, <configdir>, <docsrc>/conf)/call_apiref.sh
# build_apiref = 


# root of the build directory
# build_dir = build/


# cleans old output
# clean = False


# configuration directory
# conf_dir = <docsource>/conf/


# attribute of derived class <<self.name>>
# docname = setupdocx


# document source
# docsource = docsrc/


# created document type
# see --help-doctypes
# doctype = html


# attribute of derived class <<self.name>>
# name = setupdocx


# <year>.<month>.<day>
# release = test-release 


# path list of source directories to be processed by call_apidoc.sh and call_apiref.sh
# the syntax is a semicolon separated list, e.g.:
#
#   srcdir = setupdocx;bin
#
# srcdir = setupdocx;bin;utilities


# the document version
# version=  


[metadata]
#
# some minor static metadata are located here, while the main metada remains in 'setup.py', 
# in particular the combined and dynamic evaluated parameters 
#

# maintainer
maintainer = acue


# maintainer email
maintainer_email = acue_sf2@sourceforge.net


# urls
project_urls = 
	home = https://sourceforge.net/projects/setupdocx"
	documents = https://setupdocx.sourceforge.io/
	runtimerepo = https://pypi.org/project/setupdocx/
    downloads = https://pypi.org/project/setupdocx/
    downloads1 = https://sourceforge.net/projects/setupdocx/
    source = https://github.com/ArnoCan/setupdocx/
    source1 = https://sourceforge.net/projects/setupdocx/
    source2 = https://bitbucket.org/acue/setupdocx/
    tracker = https://github.com/ArnoCan/setupdocx/issues


# the classification of this package
classifiers = 
	Framework :: Setuptools Plugin
    Development Status :: 3 - Alpha
    Environment :: Console
    Environment :: MacOS X
    Environment :: Other Environment
    Environment :: Win32 (MS Windows)
    Environment :: X11 Applications
    Framework :: IPython
    Intended Audience :: Developers
    Intended Audience :: System Administrators
    License :: Free To Use But Restricted
    License :: OSI Approved :: Artistic License
    Natural Language :: English
    Operating System :: MacOS :: MacOS X
    Operating System :: Microsoft :: Windows
    Operating System :: Other OS
    Operating System :: POSIX
    Operating System :: POSIX :: BSD :: FreeBSD
    Operating System :: POSIX :: BSD :: OpenBSD
    Operating System :: POSIX :: Linux
    Operating System :: POSIX :: Other
    Operating System :: POSIX :: SunOS/Solaris
    Operating System :: Unix
    Programming Language :: C
    Programming Language :: C++
    Programming Language :: Cython
    Programming Language :: Java
    Programming Language :: Python
    Programming Language :: Python :: 2
    Programming Language :: Python :: 2.7
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.5
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: Implementation :: CPython
    Programming Language :: Python :: Implementation :: IronPython
    Programming Language :: Python :: Implementation :: Jython
    Programming Language :: Python :: Implementation :: PyPy
    Programming Language :: Unix Shell
    Topic :: Home Automation
    Topic :: Internet
    Topic :: Scientific/Engineering
    Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
    Topic :: Security
    Topic :: Software Development
    Topic :: Software Development :: Build Tools
    Topic :: Software Development :: Code Generators
    Topic :: Software Development :: Compilers
    Topic :: Software Development :: Debuggers
    Topic :: Software Development :: Embedded Systems
    Topic :: Software Development :: Interpreters
    Topic :: Software Development :: Libraries
    Topic :: Software Development :: Libraries :: Application Frameworks
    Topic :: Software Development :: Libraries :: Java Libraries
    Topic :: Software Development :: Libraries :: Python Modules
    Topic :: Software Development :: Libraries :: pygame
    Topic :: Software Development :: Pre-processors
    Topic :: Software Development :: Testing
    Topic :: System :: Distributed Computing
    Topic :: System :: Installation/Setup
    Topic :: System :: Logging
    Topic :: System :: Monitoring
    Topic :: System :: Networking
    Topic :: System :: Operating System
    Topic :: System :: Shells
    Topic :: System :: Software Distribution
    Topic :: System :: System Shells
    Topic :: System :: Systems Administration
    Topic :: Utilities


# keywords
keywords = ARM
	GhostBSD
	LinuxMint
	Manjaro
	TrueOS
    Aix
    Alpine
    AlpineLinux
    Arch
    ArchLinux
    ArchLinuxARM
    Armbian
    BSD
    BlackArch
    BlackArchLinux
    CPython
    CentOS
    Cygwin
    Darwin
    Debian
    Distribution
    DragonFlyBSD
    Fedora
    FigureWrap
    FreeBSD
    Gentoo
    HP-UX
    IPython
    ImageWrap
    IronPython
    Java
    Java
    Jython
    Kali
    KaliLinux
    Linux
    MacOS
    Minix
    Minx3
    NetBSD
    OS-X
    OpenBSD
    OpenSUSE
    OpenWRT
    PyPy
    Python2
    Python3
    RHEL
    Raspbian
    ReactOS
    SLES
    Scriptin
    SnowLeopard
    Solaris
    Sphinx
    Sphinx
    SuSE
    SunOS
    SunOS5
    Ubuntu
    Unix
    WSL
    WSL 1.0
    WSL 2.0
    WSL-1.0
    WSL-2.0
    Windows
    Windows10
    Windows2003
    Windows2008
    Windows2010
    Windows2012
    Windows2016
    Windows2019
    Windows2019se
    Windows7
    Windows8
    WindowsXP
    bitarray
    bitmask
    build_apidoc
    build_apiref
    build_docx
    commands
    distutils
    doc
    documentation
    docx
    enumerate
    epydoc
    extension
    hexvalue
    image
    imagewrap
    info
    install_docx
    list
    literalincludewrap
    mkdocs
    pandoc
    pkg_docx
    setup
    setup commands
    setup.py
    setuplib
    setuplib.dist.Distribution
    setuptools
    show
    sphinx
    sphinx extensions
    sphinx-apidoc
    sphinx-build
    sphinx.ext.imagewrap
    sphinx.ext.literalincludewrap


platforms = Aix
	GhostBSD
	LinuxMint
	Manjaro
	TrueOS
    AlpineLinux
    ArchLinux
    ArchLinuxARM
    Armbian
    BlackArchLinux
    CentOS
    Cygwin
    Darwin
    Debian
    DragonFlyBSD
    FedoraLinux
    FreeBSD
    GentooLinux
    HP-UX
    KaliLinux
    MacOS
    Minix
    Minx3
    NetBSD
    OS-X
    OpenBSD
    OpenSUSE
    OpenWRT
    RHEL
    Raspbian
    ReactOS
    SLES
    Solaris
    SuSE
    SunOS
    SunOS5
    Ubuntu
    Unix
    Windows10
    Windows2003
    Windows2008
    Windows2010
    Windows2012
    Windows2016
    Windows2019
    Windows2019se
    Windows7
    Windows8
    WindowsXP

7.15.2. Download

setup.conf