7.13. setupdocx.install_docx¶
For current help refer tot the online help:
python setup.py dist_docx --help
Alternative implementations are:
ipython setup.py dist_docx --help jython setup.py dist_docx --help # requires special install of setuptools, refer to the manuals pypy setup.py dist_docx --help ipw.exe setup.py dist_docx --help # IronPython on Windows
With current output:
Common commands: (see '--help-commands' for more) setup.py build will build the package underneath 'build/' setup.py install will install the package Global options: --verbose (-v) run verbosely (default) --quiet (-q) run quietly (turns verbosity off) --dry-run (-n) don't actually do anything --help (-h) show detailed help message --no-user-cfg ignore pydistutils.cfg in your home directory Options for 'install_docx' command: --name package name, changes 'self.name', default: 'self.name' --build-dir installation source, default 'build', resulting in the created document 'build/apidoc/<docname>' --docname document name, could be different from '--name' used as the input and the output name of the document, default: 'self.name' --no-exec (-n) print only, do not execute --target-dir installation target directory, PEP-370, user data directory, default '/user/data/' + 'doc/en/html/man3' --doctype document type to install, default 'html' only --no-exec (-n) print only, do not execute --debug debug flag --verbose verbose flag usage: setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...] or: setup.py --help [cmd1 cmd2 ...] or: setup.py --help-commands or: setup.py cmd --help Help on usage extensions by setupdocx --help-setupdocx
7.13.1. Module¶
installs created documetation
7.13.2. InstallDocX¶
7.13.2.1. finalize_options¶
-
InstallDocX.finalize_options()[source]¶ Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done. Thus, this is the place to code option dependencies: if ‘foo’ depends on ‘bar’, then it is safe to set ‘foo’ from ‘bar’ as long as ‘foo’ still has the same value it was assigned in ‘initialize_options()’.
This method must be implemented by all command classes.
7.13.2.2. initialize_options¶
-
InstallDocX.initialize_options()[source]¶ Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, ‘initialize_options()’ implementations are just a bunch of “self.foo = None” assignments.
This method must be implemented by all command classes.