pyccel-quickstart¶
The pyccel-quickstart script generates a Pyccel documentation set. It is called like this:
$ pyccel-quickstart [options] [projectdir]
where projectdir is the Pyccel documentation set directory in which you want to place. If you omit projectdir, files are generated into current directory by default.
The pyccel-quickstart script has several options:
-
-q,--quiet¶ Quiet mode that will skips interactive wizard to specify options. This option requires -a and -v options.
-
-h,--help,--version¶ Display usage summary or Pyccel version.
Structure options¶
-
--sep¶ If specified, separate source and build directories.
-
--dot=DOT¶ You can define a prefix for the temporary directories: build, etc You can enter another prefix (such as “.”) to replace the underscore.
Project basic options:¶
-
-aAUTHOR,--author=AUTHOR¶ Author names. (see
copyright).
-
-vVERSION¶ Version of project. (see
version).
-
-rRELEASE,--release=RELEASE¶ Release of project. (see
release).
-
-lLANGUAGE,--language=LANGUAGE¶ Low-level language. (see
language).
-
--suffix-library=SUFFIX_LIBRARY¶ Suffix of 3 letters for the project. (see
source_suffix).
-
--master=MASTER¶ Master file name. (see
master_doc).
-
--compiler=COMPILER¶ A valid compiler. (see
compiler_doc).
-
--includeINCLUDE¶ path to include directory. (see
compiler_doc).
-
--libdirLIBDIR¶ path to lib directory. (see
compiler_doc).
-
--libsLIBS¶ list of libraries to link with. (see
compiler_doc).
-
--convert-only¶ Converts pyccel files only without build. (see
convertion_doc).