From 922b9879b8b419e6e58d451214ff136871e9986d Mon Sep 17 00:00:00 2001 From: Christian Van Wambeke Date: Thu, 12 Apr 2018 14:11:06 +0200 Subject: [PATCH] fix doc/rst_prolog.rst avoid bug https://github.com/sphinx-doc/sphinx/issues/2445 --- commands/package.py | 23 +++++--- doc/rst_prolog.rst | 18 ++++++ doc/src/commands/clean.rst | 110 +++++++++++++++++++++++++++++++++++ doc/src/commands/environ.rst | 10 ++-- doc/src/commands/package.rst | 105 +++++++++++++++++++++++++++++++++ doc/src/conf.py | 10 ++-- doc/src/images/sat_v5.0.png | Bin 0 -> 10035 bytes doc/src/index.rst | 14 ++++- doc/src/usage_of_sat.rst | 5 +- doc/src/write_command.rst | 13 +++-- 10 files changed, 284 insertions(+), 24 deletions(-) create mode 100644 doc/rst_prolog.rst create mode 100644 doc/src/commands/clean.rst create mode 100644 doc/src/commands/package.rst create mode 100644 doc/src/images/sat_v5.0.png diff --git a/commands/package.py b/commands/package.py index 5a2c493..e1126e0 100644 --- a/commands/package.py +++ b/commands/package.py @@ -1157,14 +1157,21 @@ def description(): :return: The text to display for the package command description. :rtype: str ''' - return _("The package command creates an archive.\nThere are 4 kinds of " - "archive, which can be mixed:\n 1- The binary archive. It contains all the product " - "installation directories and a launcher,\n 2- The sources archive." - " It contains the products archives, a project corresponding to " - "the application and salomeTools,\n 3- The project archive. It " - "contains a project (give the project file path as argument),\n 4-" - " The salomeTools archive. It contains salomeTools.\n\nexample:" - "\nsat package SALOME-master --bineries --sources") + return _(""" +The package command creates an tar archive of a product. +There are four kinds of archive, which can be mixed: + + 1 - The binary archive. + It contains the product installation directories plus a launcher. + 2 - The sources archive. + It contains the product archives, a project (the application plus salomeTools). + 3 - The project archive. + It contains a project (give the project file path as argument). + 4 - The salomeTools archive. + It contains code utility salomeTools. + +example: + >> sat package SALOME-master --binaries --sources""") def run(args, runner, logger): '''method that is called when salomeTools is called with package parameter. diff --git a/doc/rst_prolog.rst b/doc/rst_prolog.rst new file mode 100644 index 0000000..9ead7c9 --- /dev/null +++ b/doc/rst_prolog.rst @@ -0,0 +1,18 @@ + + +.. _SALOME: http://www.salome-platform.org +.. _SPHINX: http://sphinx-doc.org +.. _CAST3M: http://www-cast3m.cea.fr +.. _MATIX: ../../MATIX_PROFILE/doc/index.html +.. _C++: http://www.cplusplus.com/ +.. _CMake: https://cmake.org/ +.. _Python: https://docs.python.org/2.7 +.. _ParaView: http://www.paraview.org +.. _Anaconda: https://docs.continuum.io/anaconda/pkg-docs# +.. _Miniconda: http://conda.pydata.org/miniconda.html +.. _Git: https://git-scm.com +.. _GitCheatSheet: https://services.github.com/kit/downloads/github-git-cheat-sheet.pdf +.. _CLI: https://en.wikipedia.org/wiki/Command-line_interface +.. _Tar: https://en.wikipedia.org/wiki/Tar_(computing) +.. _OS: https://en.wikipedia.org/wiki/Operating_system + diff --git a/doc/src/commands/clean.rst b/doc/src/commands/clean.rst new file mode 100644 index 0000000..33a0a7c --- /dev/null +++ b/doc/src/commands/clean.rst @@ -0,0 +1,110 @@ + +.. include:: ../../rst_prolog.rst + +Command clean +**************** + +Description +============ +The **clean** command +TODO +TODO +. + +Depending on the selected options, the created archive includes sources and binaries +of SALOME products and prerequisites. + +Utility *salomeTools* is also included in the archive. + +.. important:: + By default the package only includes the sources of the prerequisites and the products. + To select a subset use the *--content* option. + + +Usage +===== +* Create a package for a product (example as *SALOME_xx*): :: + + sat package SALOME_xx + + This command will create an archive named ``SALOME_xx.tgz`` in the working directory (``$USER.workDir``). + If the archive already exists an exception is thrown. + +* Create a package with a specific name: :: + + sat package SALOME_xx --name YourSpecificName + +.. important:: + By default, the archive is created in the working directory of the user (``$USER.workDir``). + If the option *name* is used with a path (relative or absolute) it will be used. + If the option *name* is not used and binaries (modules or prerequisites) are + included in the package, the architecture (ex: MD10_64) will be appened to the name. + + Example: :: + + sat package + Creates .tar.gz in $USER.workDir + + sat package -b + Creates _.tar.gz in $USER.workDir + + sat package -n myname + Creates myname.tar.gz in $USER.workDir + + sat package -n ~/myname -b + Creates myname.tar.gz in the home directory + +* Force the creation of the archive (if it already exists): :: + + sat package --force + +* Include the binaries in the archive (modules and prerequisites): :: + + sat package --binaries + + This command will create an archive named ``_.tar.gz`` where is the architecture of the machine. + +* Set content of the archive: :: + + # only the prerequisites + sat package --content ps,pb + # only the modules sources + sat package --content ms + # only the binaries + sat package --content mb,pb + + + Possible values for content option are: + * ms: modules sources + * mb: modules binaries + * ps: prerequisites sources + * pb: prerequisites binaries + + .. note:: this option is not compatible with the *--binaries* option. + +* Include the modules and prerequisites of the base product: :: + + sat package --with_base + +* Simulate the creation of the package (only check for required components): :: + + sat package --simulate + +* Do not include sample modules (like HELLO): :: + + sat package --no_sample + + Sample modules are identified by the ``$TOOLS.common.module_info..module_type`` parameter. + + By default salomeTools creates a copy of the installer with the same name than + the package. Use this option to not generate the installer. + +* Do not delete version control system informations from the configurations files of the embedded salomeTools: :: + + sat package --with_vcs + + The version control systems (vcs) taken into account by this option are CVS, SVN and Git. + +Configuration +============= +No specific configuration. diff --git a/doc/src/commands/environ.rst b/doc/src/commands/environ.rst index 6feb114..2646747 100644 --- a/doc/src/commands/environ.rst +++ b/doc/src/commands/environ.rst @@ -5,11 +5,13 @@ Command environ Description =========== The **environ** command generates the environment files used to run and compile SALOME. -Please note that these files are not required! SalomeTool set the environment himself, when compiling. +Please note that these files are not required any more, +salomeTool set the environment himself, when compiling. And so does the salome launcher. -These files are useful when one want to check the environment. -They are also used in debug mode to set the environment for gdb. -The configuration part at the end of this page explains how to specify the environment which will be used by sat (at build or run time), +These files are useful when someone wants to check the environment. +They could be used in debug mode to set the environment for gdb. +The configuration part at the end of this page explains how +to specify the environment which will be used by sat (at build or run time), and which is written in files by sat environ command. Usage diff --git a/doc/src/commands/package.rst b/doc/src/commands/package.rst new file mode 100644 index 0000000..bc6c6d2 --- /dev/null +++ b/doc/src/commands/package.rst @@ -0,0 +1,105 @@ + +.. include:: ../../rst_prolog.rst + +Command package +**************** + +Description +============ +The **package** command creates a SALOME_ archive (usually a compressed Tar_ file .tgz). +This tar file is used later to intall SALOME on other remote computer. + +Depending on the selected options, the created archive includes sources and binaries +of SALOME products and prerequisites. + +Utility *salomeTools* is also included in the archive. + +.. note:: + By default the package only includes the sources of the prerequisites and the products. + To select a subset use the *--content* option. + + +Usage +===== +* Create a package for a product (example as *SALOME_xx*): :: + + sat package SALOME_xx + + This command will create an archive named ``SALOME_xx.tgz`` in the working directory (``$USER.workDir``). + If the archive already exists, do nothing. + +* Create a package with a specific name: :: + + sat package SALOME_xx --name YourSpecificName + +.. note:: + By default, the archive is created in the working directory of the user (``$USER.workDir``). + If the option *name* is used with a path (relative or absolute) it will be used. + If the option *name* is not used and binaries (modules or prerequisites) are + included in the package, the OS_ architecture (ex: *MD10_64*) + will be appended to the name. + + Examples: :: + + # Creates SALOME_xx.tgz in $USER.workDir + sat package SALOME_xx + + # Creates SALOME_xx_.tgz in $USER.workDir + sat package SALOME_xx --binaries + + # Creates MySpecificName.tgz in $USER.workDir + sat package SALOME_xx --name MySpecificName + + +* Force the creation of the archive (if it already exists): :: + + sat package SALOME_xx --force + +* Include the binaries in the archive (products and prerequisites): :: + + sat package SALOME_xx --binaries + + This command will create an archive named ``SALOME_xx _.tgz`` + where is the OS_ architecture of the machine. + +* Set content of the archive: :: + + # only the prerequisites + sat package --content ps,pb + # only the modules sources + sat package --content ms + # only the binaries + sat package --content mb,pb + + + Possible values for content option are: + * ms: modules sources + * mb: modules binaries + * ps: prerequisites sources + * pb: prerequisites binaries + + .. note:: this option is not compatible with the *--binaries* option. + + +* Simulate the creation of the package (only check for required components): :: + + sat package --simulate + +* Do not include *sample* modules (like HELLO): :: + + sat package --no_sample + + Sample modules are identified by the ``$TOOLS.common.module_info..module_type`` parameter. + + By default salomeTools creates a copy of the installer with the same name than + the package. Use this option to not generate the installer. + +* Do not delete version control system informations from the configurations files of the embedded salomeTools: :: + + sat package --with_vcs + + The version control systems (vcs) taken into account by this option are CVS, SVN and Git. + +Configuration +============= +No specific configuration. diff --git a/doc/src/conf.py b/doc/src/conf.py index 71b983c..1a2fc74 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -28,6 +28,9 @@ import os # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc'] +# do not use rst_prolog please +# https://github.com/sphinx-doc/sphinx/issues/2445 + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -94,7 +97,6 @@ pygments_style = 'sphinx' # a list of builtin themes. # default sphinxdoc scrolls agogo traditional nature haiku html_theme = 'alabaster' -html_theme_path = ["../_themes/alabaster", ] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -102,7 +104,7 @@ html_theme_path = ["../_themes/alabaster", ] #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = ["../_themes/alabaster", ] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -113,12 +115,12 @@ html_theme_path = ["../_themes/alabaster", ] # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +html_logo = "images/sat_v5.0.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -# html_favicon = "images/sat_v5_small.ico" +# html_favicon = "" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/doc/src/images/sat_v5.0.png b/doc/src/images/sat_v5.0.png new file mode 100644 index 0000000000000000000000000000000000000000..1057f5b8f07071382476cd8963dd0316c03248e1 GIT binary patch literal 10035 zcmV-3C(PK1P)WFU8GbZ8()Nlj2>E@cM*03ZNKL_t(|+O3>p# z`mXQ#uB~o-<3}Y@igE35fGCA10EJSTLxYrQ?Z~ZAJ3$$PpoonkHilVkiHxR~8no6F zjnGL9=kgk@H7MoB6k)TUaz1Ym{AXGzl!8k}9p;V0q0kDnR@^tQ8D@qW&AhZ=08uET z=^90pM2t&6mQnzqwB}GR;q(R+l5XW?T3qddnBCSy37_F=lEoz4qA&U)4n=q;VX}f8}ec{D)lbF8N%o|HB zLMM*ctt?6_8emdbESAIllp5IVCe#9p%F+Ol(o|NKLnBIgqjs>cj{9aM$`~}@fYolo z;a<#{+%g(Qt>K?v)U0$O?prh%rD&WWfS_1O43nZkYj0elK%vk|5CtNF!oOs}8;yc? zGC@FrlH~%}_cFI#pGJSd3ESMZw)?&Jh_! zndc}4kp^uP)7g~O(TLsg7$xGLL4@gS%I4Y{brq4s5lS5SY)(EM)9>{$MkCIm6)5LW zA{4U;k%&VpO;I~^1ijeM2xw!NmEMR%U{+a#hJF@vs1tF1;fPRJ2TBWQMXD8x#xbiM zC`D{Ey(|U=M|uh0+$o5)rgRcssA8j=ur;sI#;;Wu=5=0L?sYIN86uEfzxV`8nCmldaWrDezNthL_ z6sghd)HQ_@lybPTL21RMqYk^3<>)X)Db03KgHjY$uuf>ip(Wrttx#528>HMf-@{zX zU^dJm=A~t~v?yg;;}a1Qqd7aTupv|u!e}Sb>=u@tq7F_^1tWw>C!uaE3oC6fQ_4fb z(mGC$bMIjhkBt=cB0~~s#zl<|FJ2*t6PyTVCb>T!+UsJ3+FH&|7ewJVmPS$4HD%LK zH`Ze>1Ox0$7hJN|XTB&fk;erJAD)cX9xebLkbu&P$t-8s?J$|ny^j?kjtokK#2D6B zSBVvrRfSQ)e74|ZQDC$pU*tpqHYlZ;FJ`O^hRn(mWfX~t=#5s8Drd62O&Uk!vnjDL z07Q!b+}ArXvqmVbUtvx`Wrfl;bRx}Vs~M+fbsHK$a7u>)7ny6 z#~_W_ErL-5kgiY|6yvI4CvQTSRIGGj5I8nUDJ&e1BPL}-<3MT1txz@&YaPmH@7;pc zBwABj7rfyT^eeymw8uosEd7!97)FCp9+NFS&(dWMQp2gT@h?5ZV}Bk*AvsY2#4iok zgfX>dY0lm-G&GH)8)?7LWY5t2J$mC^8pqNzTIBMbRXU(U1-13j2MM7zEb5)< zoRxl;-SHF`4BY`3O}~>+^<6ovye(h)lMr-b! zRK$^DHH*m`M`1lKiH$+TdyKO2S?F$M>Bfe`y%eK0jVNmCy`cx?!Z3@ORu*Lx%l}PF zivzl)D#xVZABIOabasj^w zOHwFoFt}xks+7VxN2C>2{DRxVYH|SY2V@mM_A(h*23K_u(5rCv0gSJ())EDHv6m6} z^9$=(NfIO%+WaGg`qE<^8Y>=?X+<}Q5OH*qn5LUC>|`i$C zaTL~Zep-3A4&EN+VFPXdJb3I0tLPm^-%TnBdm60#SlP0Cu zipgxopx0+Qo#4b9Za2$79HU{MB=TA4&h{2MBq2&HtD_;du9jR4I3Y?>vQC#IO_-j) zkEm%^qYpn;glXl7jOK7Jrm!%tEL!^zs+Gqixpi#zGZwYwNIzv>I~LX(D*~f#!lbkq z0QszTNT8@-rrWN5_mTFY>_OauTdaAKu{QY!r39`%8Oi+Ty2 zNE0o?TX2L~WXKFm%DCmQ1kZbI^in28<-?9F=@V~&o4tfyY><$x>Trz{|GhCf@L@hY z8g1B`F3`$xes>lyq4(GtsH%!lH*3RoxD0I+vqerPO(?6X{e9;gRb}a{jA)XCVXuqA zQ7q;t1$W(b7wcG?TBN;?|lAi zl-7Bmt3B8rSC*{>WQpNfR~_NuhldQ(2xFATY5O=O1w=;s^xb+;ENK4ro^Ag6t{vjY zFl#(N(*RMVdD5{FC)RpgG)O6%CDGhE77$_7joHn85~92<6C2HM{mq>Sio16f0e5*r zBVebzcATE%Jo?CxXB=N`@mgvWpSbNF7FFGnz)K*1&-R?dqYh_w=fMC$#PR$`T+ESv zN-vFB6cuNt1%LjnlZZH8d)-wYuPH@oZMetaRYm9}F;!Cs!(Apc-iZ61lzCnd8^ve7 z^p7NgbDPc=99bJt8j z#XOkfSAO|@M6b9Br3qmrkfB;Ir~vL2x1F8xdoR3(Zfx3XPv8D!{@87xY!mRGH$ZWg zOlxnnTBF2qd^F%~H$3vdZ$IlbZ(^JbSbzKt{K#W3~m@4{k0!vv@C1)Ry-? z^HB$`{m4f?!skBm5mrt-0ujqYb$sP>w<4mb>xQ#iJAC_|(>QVDML}8D7_Ir)AARYA zGBAMKzkLT^`^LAyd497y=+o^F(V{$VNFq%qGHm6Zm+2Y!*w4M-A$drx72A13C-%I| zCvWuth0pVhg5UqpO~NIXvX%e%Ju z!d+Vju6@t5uBDpKkY&ZdIdCqFB{(NM@5+lfvDR;|nNFv?=}m9qvSZ`-Q^{y)YqtgzNi*yyKh_ER?diT~>+Z1xg1 zJ8}3f;n=9dhraZk1Gn^JuX+`$|MaIEUg?MHQ`Y+#t6|Keql|Zc|G_Z%(wDxJ?r_9& zZ+bh&R=QlWe(0`YqD6qo5U{JcZzZ zl{BWXjx3JQMpHS*v|82)p%+_D%_?5@myE|-=dh!Lbbt%{!XXEO0UZ^9=&Jm&N;5R z<{BPb<&q zY>s++uC^?B!|PwirBD4qI=uml#uu9<%>I&9uU%l)mCr_cv7r>L)SVEx=Z|`oe2nIm6|1P=Tfp|NNCMsjUlTFi(UnA(c^3JE3%Y zbw(8Y{%t3D=_8MD>8hW%M?L0oJncW;!tK%HkkXfv8i7%k@Um-pBB5>;7yP1r~=qT~zds$sD zr%EZR#f)BmfKvr=oDelm=qH-WLE(bAiI62xdtsWU{Oe!)zyrnufB1X9!|>AUNV*+1 z23h<0(W6KCm0x}TgTflU)R1WS(mmUZ2iG#G9p>4Wv3~UvnU=LjZBFf{=?^mN_m91( zR&JwY$A45N z^-VY3M4m7B{@1;Wx+;S{N!sed^0?uK8@S;?WXq3x<_ouW_#H9jyvw) z+9y28FB~gOr&FHv_{X>3-*Wfe-2Sz%@$eIuGT+&z+xspUSbVf`O~c_!E@OP|4B7#+ z%Cp>q#E=->iq0OYxw0&yO+H%>f|w;s%k6+|3&?=1NA z?Wf!EldQwPdeSkP+JbXjdt}75hez%AU;XM=`Pj!k#v_01%~%x?YZXG^Qj7A?9H0BI z|AD$`+IX*)`lS0UvOLe(*xbaRSXmv>$+83AfAy6|0ZI`l_t zxTfLEo!>xfAqr(O8WF0pVU)$BCO+WF9_(SQ_2rO*BVTG5~{DJczTO(*uMSsR3q z?z>F>$w|q{Y51FzoSK!Ko|c@RmzwoPR(;pPjXIA3QkRm z@b8>6;|1pzC2zg;D+kHY7d)M(44MPp^n)M#Aa~w*Cs)7zy_`I|&ACa=*~xLY{sGO;CqD6s3!XJi60i;fq>*N0eaOb@=t7K}7ffd}L@Tl^-?|kPwdH9QdoOJz=FSg^wn`vyY z)*%YwrsS3X{xAHT*oMnCSGecwb`SyhOwk0OpBYUj)-+Yct6%y2_P6f3>n;E;x%dcY z&z{3Ni`a&9Tf1J4eF3St)Zuwuui*Ij$3ITDn^7$0^g0=3Q6NptHIIAZflELC`OkCx z&%FVHUd;p?8+8-ItZMv>hdQ0L@WQ8F$;BIkkkoZ>`3_1z( z!~M2)s16j{9T%;Qclgo)BsLeUyz8&Oo=YEo z1(#iMg)h=O3j#@+(CcK_x}mBH`n?_}9)4x3UIF;c-~3HbiYGqi(G;_BE18OoA!-~9 z(zvB1ykoFD|H+qg-Bm{)G#`aLy+``ANR;g)i{rcYGLI7VV;P2+nx?Dvbji zFL}&^t6ert!+YQRUaq+AdY;pMYpFYjaH{Z;QpM4`u zUD6$_(BxBkgB4s|5|xdmXe?P0(TTjup|nex&4UBzH{N(7r%v9>6+iqwaQ1?<9AI2p z22MyL!%Ei#K&jX+8t*}!mk-ObhIs#w7q}S|G)_1-t4JfwscDHQ-Fl+k;=<6-O(J?E zbmOJ=U4=dbMYPdFYuL>js>TLm_nCJmHm$~NDa}DE1WRlb9qlDTw|@OJuejz|TRyVZ z@|xGYn&VGbmP=ptexlw8K}chL0VeZh9IvR|DH;-^IXp-( zT5&Asy~d@*3e4p~Ot+^_-SaGo4!ZZyV*p<3b^qhsyu#&0OHC;yjItQ(U|M_cHppT+ zNf1jrM<+IPV$&LYYiJsDtXWi+BcmR(vZh1Cdq4Lz{@`VvJA3u3UyT!Z`c1#c+3}2~ z)$RuknQO2c15R#DD4XxSK)zTk_`ARRJ8rq<7C!vp-=@>+^U8Pq8b)16h-_}Gk(via zlGAp3Kc&5XLW zD1_2FPW`u!Qho83R%m$DzxjK}XFhKU^F3tXrWv>q+s z$zg1WjAoKoXytjeH(qywN7QF{@>8D5jc@){va6p;9U6d@QkWoj#yTFhKIGo5F_BSN zo$$x6d-nGxMu=jLUVbH)KlVvH{W&kh*@i(kBTh5k_Oj>g5w!pIKT$2_L{Y^1-uRmD z+0X|4K99QkD!%_IPv-HDyppQSiGv9l{M_lLVX(H2diooFM@0L!vrcS?BEzh9SOJ}6 zXcLh}nly=gBZn25&^y>mBb`M`*vP4Ok)ZwY!!{~0SI`?Xdp^h z8+37aBXq^A9ee4KypbuUjXePPbx0zPjxx?pi?%^VS~CrGPmR~-mw*0A zzWJrU;<+FE1mm4u>d*k9#2cqZ(9UtuN{@5nS?CK9(r(Wu20!2$a7{z6-^UiXMRs==bH~o>phNW z9nyKfRe{52eyP!+ZO+#gcT4M)s>|&Nmb}0cmxY4upqsF>XuxO&iSGp%rZMxz(m1?O zGVwhF<+Ay9$$W-9PN5lfA`0spEF>`3OH|=RF-SC*taP|{Qqj*Mk`N+|63#DtyWR0o z#=X;$No4~J3(dPIl<|dr=M+=hv{|RxSB5%1$~ZGCTY96FQ6p#+!&rMyR#a`Dpjqv(`=GT7oR7$I`v^s49gPTsPRgvZ^wXHG z2$h9-?O(ST+3WlPMxB`Lyg?iPDrS{Ml;74Mjtz-X9O}gkvWPReB@GS5c@sKjwBD8c{ol znmtFlq~CV)n%W80xi(y?{o5Vju*RS38rL=wFFjQ>SjPo#RMbrX`+J6_fR#?dD2o}U zk?#~!FkR$G;L>*IIfq6)zH|CqXf6@Yo8eluhcU_<*s@(N&;}AT=8HUMb9F>f#iFjzMiFbxW-r3xHU3LFWY~$= z$^BLb-d#xh;+4@@CzL=X@b&Z1KT*p700xUmL_t(JX<~>KbR!>L>!2WYfu6W;T87PA z_O+uedq5qm^<(avR{@H72%tlyd(v1midkiuRhDU$x1n%pi=D`Dc#!d(?FEt1dqx&c zJTyqTY^CFwdr>Im_8Liov2~nb(aMJ+1=?BWMMah*IPr!>(D*Mi?X8^&N7hE1-P%TL;|UTcs6dhqdmW0R z;+^4Y8N!ZS7v{BSnsFg5pgzdsNc=TdJ6lo51<3JrK7PUo; zrl@>}HwrQnGGr&AyH?sjtHO>ahleR=W@TF>_C1EQz(21WDr=e54&y>|h7JHx-Dos2C*-6Pl~cl2E6_&csvn$v1U;>J|hjE`H&@uwe-^-TcR+LI?&a$ zH00@`px;S-H@F5Z&bQ!+SMgdAW{aF8PRL@7RtZUD$RdqairI9A6U)}l7+Y6VWf`gn zV2laB=MbeC@9eO?y24^S2J3wHxwB+xN)pFpS&A0NY6JWy{H`*bz*KmyYO&NX?n57HjYjbai|~BIANogaPPEYt()M0?V=7P zuOQ25iDutECi|Lhm+bv&CuVC_v&`(5NrNnnD745Kvn)BOeY!3c_K@(cXWHoYN)`Gj zJ?4?NYsx1|d)^NGMmOijb5{Eq)4U7?emPKSD5{2GH}OL_-x)SY;&z;V8snVf$f(b^ z?m0!G6_Y$?Y&~VN6gO67#rmj^xCUo!dvD7v4+#5Z>};K9eSM8O&q?E$EKMl$1x;D7 zJD(7V!x%-LSHyA5Xk(N7{F%_@FGQ%lO_bDu4rWCsHSCs+$0)|{i_zf4iHq8Xp0D<8 z&`%?j)=a{dQib(9*-R=+Z2TS#8@&XFq7!R!>%-iEN~CIAY5hbEQtq2o=xFbiF04b) z6nV{7UXvQHhnrR26B`W=8)XNImU-jY=)_dcyYSpPzpuwWBXeynN%mKm{J*ugP#cuP zvKMS2WQgsqJVD#5~QSnK($&Z}WPHXC+Q z*18#aRa2G~i=yz^A;M%j!vN#Slzt~;Hl6!TbM#(cyAEoW-Q5YB>nrSRZTabP5;nLI z`n@h%YdWz(D@8IGFy7i?KHeeHdwa?G$?=%YHZ}9@Ee7kG6uVnE+Yt5R2rEKiz4`-$ zG>(XjW?H(oo>@EC$!m=9JHD*<5*jCz!Qe)ngre~isMOv*5Kil`mOb@xW?He@joAv^ z*^yohN(H5@$>sMqJ8}d4oyOe6T1dyd`2`*uymvG;_@!mx_L=>~#f;|>XxOBD4 zx3(6oOG{(JWviX#mLv$m;cmj&MNO7OsC{@(?aOj6>LoPJ5$R=ew1|z57NJ%cbiB?%6WL+HbG|f6Dct$H6s3^RUBC68X?(jAl|h^2W9vs@<$D09EH4+w&Tu6-lhQe67QF z;o0!AwEOmgP7nH4G3#g@R+KNy*+fpo5Wf>Pu%aVxo@ZjEYP8#WbA#(pdEJ7zTjOUf# znQ6J log environ + clean + package Code documentation ================== diff --git a/doc/src/usage_of_sat.rst b/doc/src/usage_of_sat.rst index 0f6be19..80c7b46 100644 --- a/doc/src/usage_of_sat.rst +++ b/doc/src/usage_of_sat.rst @@ -1,10 +1,13 @@ + +.. include:: ../rst_prolog.rst + ******************** Usage of SAlomeTools ******************** Usage ===== -sat usage is a Command Line Interface (CLI). +sat usage is a Command Line Interface (CLI_). .. code-block:: bash diff --git a/doc/src/write_command.rst b/doc/src/write_command.rst index 726c553..adad305 100644 --- a/doc/src/write_command.rst +++ b/doc/src/write_command.rst @@ -1,9 +1,14 @@ -*************** -Write a command -*************** + + +Add a user custom command +*************************** Introduction ============ + +.. note:: This documentation is for python developers. + + The salomeTools product provides a simple way to develop commands. The first thing to do is to add a file with ".py" extension in the **commands** directory of salomeTools. @@ -141,4 +146,4 @@ Get the help of mycommand: Available options are: -m, --myoption (boolean) - My option changes the behavior of my command. \ No newline at end of file + My option changes the behavior of my command. -- 2.39.2