doc/build/html/commands/doc.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>Command doc &#8212; salomeTools 5.0.0dev documentation</title>
  10     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" src="../_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="../_static/jquery.js"></script>
  14     <script type="text/javascript" src="../_static/underscore.js"></script>
  15     <script type="text/javascript" src="../_static/doctools.js"></script>
  16     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17     <link rel="index" title="Index" href="../genindex.html" />
  18     <link rel="search" title="Search" href="../search.html" />
  19     <link rel="next" title="Command config" href="config.html" />
  20     <link rel="prev" title="Usage of SAlomeTools" href="../usage_of_sat.html" />
  21
  22   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  23
  24
  25   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  26
  27   </head><body>
  28
  29
  30     <div class="document">
  31       <div class="documentwrapper">
  32         <div class="bodywrapper">
  33           <div class="body" role="main">
  34
  35   <div class="section" id="command-doc">
  36 <h1>Command doc<a class="headerlink" href="#command-doc" title="Permalink to this headline">¶</a></h1>
  37 <div class="section" id="description">
  38 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
  39 <p>The <strong>doc</strong> command displays sat documentation.</p>
  40 </div>
  41 <div class="section" id="usage">
  42 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  43 <ul>
  44 <li><p class="first">Show (in a web browser) the sat documentation:</p>
  45 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">doc</span> <span class="o">--</span><span class="n">html</span>
  46 </pre></div>
  47 </div>
  48 </li>
  49 <li><p class="first">Show (in evince, for example) the (same) sat documentation in format pdf:</p>
  50 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">doc</span> <span class="o">--</span><span class="n">pdf</span>
  51 </pre></div>
  52 </div>
  53 </li>
  54 <li><p class="first">Edit and modify in your preference user editor the sources files (rst) of sat documentation:</p>
  55 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">doc</span> <span class="o">--</span><span class="n">edit</span>
  56 </pre></div>
  57 </div>
  58 </li>
  59 <li><p class="first">get information how to compile locally sat documentation (from the sources files):</p>
  60 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sat</span> <span class="n">doc</span> <span class="o">--</span><span class="nb">compile</span>
  61 </pre></div>
  62 </div>
  63 </li>
  64 </ul>
  65 </div>
  66 <div class="section" id="some-useful-configuration-pathes">
  67 <h2>Some useful configuration pathes<a class="headerlink" href="#some-useful-configuration-pathes" title="Permalink to this headline">¶</a></h2>
  68 <ul class="simple">
  69 <li><strong>USER</strong><ul>
  70 <li><strong>browser</strong> : The browser used to show the html files (<em>firefox</em> for example).</li>
  71 <li><strong>pdf_viewer</strong> : The viewer used to show the pdf files (<em>evince</em> for example).</li>
  72 <li><strong>editor</strong> : The editor used to edit ascii text files (<em>pluma or gedit</em> for example).</li>
  73 </ul>
  74 </li>
  75 </ul>
  76 </div>
  77 </div>
  78
  79
  80           </div>
  81         </div>
  82       </div>
  83       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  84         <div class="sphinxsidebarwrapper">
  85             <p class="logo"><a href="../index.html">
  86               <img class="logo" src="../_static/sat_v5.0.png" alt="Logo"/>
  87             </a></p>
  88   <h3><a href="../index.html">Table Of Contents</a></h3>
  89   <ul>
  90 <li><a class="reference internal" href="#">Command doc</a><ul>
  91 <li><a class="reference internal" href="#description">Description</a></li>
  92 <li><a class="reference internal" href="#usage">Usage</a></li>
  93 <li><a class="reference internal" href="#some-useful-configuration-pathes">Some useful configuration pathes</a></li>
  94 </ul>
  95 </li>
  96 </ul>
  97 <div class="relations">
  98 <h3>Related Topics</h3>
  99 <ul>
 100   <li><a href="../index.html">Documentation overview</a><ul>
 101       <li>Previous: <a href="../usage_of_sat.html" title="previous chapter">Usage of SAlomeTools</a></li>
 102       <li>Next: <a href="config.html" title="next chapter">Command config</a></li>
 103   </ul></li>
 104 </ul>
 105 </div>
 106   <div role="note" aria-label="source link">
 107     <h3>This Page</h3>
 108     <ul class="this-page-menu">
 109       <li><a href="../_sources/commands/doc.rst.txt"
 110             rel="nofollow">Show Source</a></li>
 111     </ul>
 112    </div>
 113 <div id="searchbox" style="display: none" role="search">
 114   <h3>Quick search</h3>
 115     <div class="searchformwrapper">
 116     <form class="search" action="../search.html" method="get">
 117       <input type="text" name="q" />
 118       <input type="submit" value="Go" />
 119       <input type="hidden" name="check_keywords" value="yes" />
 120       <input type="hidden" name="area" value="default" />
 121     </form>
 122     </div>
 123 </div>
 124 <script type="text/javascript">$('#searchbox').show(0);</script>
 125         </div>
 126       </div>
 127       <div class="clearer"></div>
 128     </div>
 129     <div class="footer">
 130       &copy;2018, CEA.
 131
 132       |
 133       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
 134       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 135
 136       |
 137       <a href="../_sources/commands/doc.rst.txt"
 138           rel="nofollow">Page source</a>
 139     </div>
 140
 141
 142
 143
 144   </body>
 145 </html>