| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| |
| <title>Sphinx — OpenPASS Documentation</title> |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/tabs.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/css/custom.css" type="text/css" /> |
| |
| |
| |
| <link rel="shortcut icon" href="../../../_static/openPASS.ico"/> |
| |
| |
| |
| |
| |
| |
| |
| |
| <!--[if lt IE 9]> |
| <script src="../../../_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> |
| <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> |
| <script src="../../../_static/jquery.js"></script> |
| <script src="../../../_static/underscore.js"></script> |
| <script src="../../../_static/doctools.js"></script> |
| |
| <script type="text/javascript" src="../../../_static/js/theme.js"></script> |
| |
| |
| <link rel="index" title="Index" href="../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../search.html" /> |
| <link rel="next" title="Quick Start" href="../installation/10_quickstart.html" /> |
| <link rel="prev" title="Simulation Installation Guide" href="../../20_sim_installation_guide.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../index.html" class="icon icon-home"> openPASS |
| |
| |
| |
| |
| <img src="../../../_static/openPASS.png" class="logo" alt="Logo"/> |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 9999.9999.9999 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <p class="caption"><span class="caption-text">Installation Guides</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../10_gui_installation_guide.html">GUI Installation Guide</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../20_sim_installation_guide.html">Simulation Installation Guide</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Sphinx</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#what-is-sphinx">What is Sphinx</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#who-uses-sphinx">Who uses Sphinx</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#why-not-markdown">Why not markdown</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#resources">Resources</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#building-this-documentation-linux-debian">Building this Documentation (Linux/Debian)</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../installation/10_quickstart.html">Quick Start</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../installation/20_prerequisites.html">Prerequisites</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../installation/30_build_prerequisites.html">Building Prerequisites</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../installation/40_cmake.html">Cmake Build Environment</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../installation/50_windows.html">Building under Windows</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../installation/60_linux.html">Building under Linux</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ides/10_vscode.html">Working with VSCode</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ides/20_qt_creator.html">Working with Qt Creator</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../21_pcm_installation_guide.html">PCM Installation Guide</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">User Guides</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../user_guide/10_gui_user_guide.html">GUI User Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../user_guide/20_sim_user_guide.html">Simulation User Guide</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Advanced topics</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/10_documentation.html">Documentation Concept</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../advanced_topics/20_simulator_advanced.html">Simulator</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Other Information</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../license.html">License</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../index.html">openPASS</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../index.html" class="icon icon-home"></a> »</li> |
| |
| <li><a href="../../20_sim_installation_guide.html">Simulation Installation Guide</a> »</li> |
| |
| <li>Sphinx</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../_sources/installation_guide/sim_installation_guide/meta/sphinx.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="sphinx"> |
| <span id="id1"></span><h1>Sphinx<a class="headerlink" href="#sphinx" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="what-is-sphinx"> |
| <h2>What is Sphinx<a class="headerlink" href="#what-is-sphinx" title="Permalink to this headline">¶</a></h2> |
| <p>Sphinx is a python based documentation generator, using <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html">reStructuredText</a> as primary import format.</p> |
| </div> |
| <div class="section" id="who-uses-sphinx"> |
| <h2>Who uses Sphinx<a class="headerlink" href="#who-uses-sphinx" title="Permalink to this headline">¶</a></h2> |
| <ul class="simple"> |
| <li><p>Everybody who publishes on <a class="reference external" href="https://readthedocs.org/">ReadTheDocs</a></p></li> |
| <li><p><a class="reference external" href="https://github.com/OpenSimulationInterface/osi-documentation">OSI</a></p></li> |
| </ul> |
| </div> |
| <div class="section" id="why-not-markdown"> |
| <h2>Why not markdown<a class="headerlink" href="#why-not-markdown" title="Permalink to this headline">¶</a></h2> |
| <ul class="simple"> |
| <li><p>Markdown was not invented to write documentation</p></li> |
| <li><p>Right now the doxygen implementation is not pure markdown, which makes it a bit nasty to use</p></li> |
| <li><p>Markdown does not support true references (and reference checking), figures (and captions), toc, glossary, versioning, …</p></li> |
| <li><p>Markdown is also supported by sphinx, but does not integrate with the cool and fancy features.</p></li> |
| </ul> |
| </div> |
| <div class="section" id="resources"> |
| <h2>Resources<a class="headerlink" href="#resources" title="Permalink to this headline">¶</a></h2> |
| <ul class="simple"> |
| <li><p><a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html">reStructuredText Primer</a></p></li> |
| <li><p><a class="reference external" href="https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html">A “How to” Guide for Sphinx + ReadTheDocs</a></p></li> |
| <li><p><a class="reference external" href="https://www.sphinx-doc.org">Sphinx Documentation</a></p></li> |
| <li><p><a class="reference external" href="https://github.com/OpenSimulationInterface/osi-documentation/blob/master/conf.py">OSI Sphinx Config</a></p></li> |
| </ul> |
| </div> |
| <div class="section" id="building-this-documentation-linux-debian"> |
| <h2>Building this Documentation (Linux/Debian)<a class="headerlink" href="#building-this-documentation-linux-debian" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># install python, pip, sphinx, spellchecker, ...</span> |
| sudo apt install doxygen python3 python3-pip python3-sphinx libenchant-2-2 dvipng |
| |
| <span class="c1"># install sphinx extensions</span> |
| pip3 install sphinx sphinx-rtd-theme sphinx-tabs breathe exhale sphinxcontrib-spelling |
| |
| <span class="c1"># build doc (only)</span> |
| mkdir build |
| <span class="nb">cd</span> build |
| cmake -DWITH_SIMCORE<span class="o">=</span>OFF -DWITH_TESTS<span class="o">=</span>OFF -DWITH_DOC<span class="o">=</span>ON .. |
| make doc |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| <a href="../installation/10_quickstart.html" class="btn btn-neutral float-right" title="Quick Start" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| <a href="../../20_sim_installation_guide.html" class="btn btn-neutral float-left" title="Simulation Installation Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2021 OpenPASS Working Group. |
| |
| </p> |
| </div> |
| |
| |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
