========================================== ``additional_samples_with_very_long_name`` ========================================== Various examples of styling applied to Sphinx constructs. You can view the `source <./_sources/examples.txt>`_ of this page to see the specific reStructuredText used to create these examples. Headings ======== This is a second level heading (``h2``). Sub-Heading ----------- This is a third level heading (``h3``). Sub-Sub-Heading ~~~~~~~~~~~~~~~ This is a fourth level heading (``h4``). Code ==== The theme uses pygments for ``inline code text`` and :: multiline code text Here's an included example with line numbers. .. literalinclude:: ../mdanalysis_sphinx_theme/__init__.py :linenos: It also works with existing Sphinx highlighting: .. code-block:: html Hello World .. code-block:: python def hello(): """Greet.""" return "Hello World" .. code-block:: javascript /** * Greet. */ function hello(): { return "Hello World"; } Admonitions =========== The theme uses the ``admonition`` classes for the standard Sphinx admonitions. Warning ------- .. warning:: This is a **warning**. Attention --------- .. attention:: Do I have your **attention**? Caution ------- .. caution:: Use **caution**! Danger ------ .. danger:: This is **danger**-ous. Error ----- .. error:: You have made a grave **error**. Hint ---- .. hint:: Can you take a **hint**? Important --------- .. important:: It is **important** to correctly use admonitions. Note ---- .. note:: This is a **note**. Tip --- .. tip:: Please **tip** your waiter. Deprecated ---------- .. deprecated:: 999.999.999 This API point was **deprecated**. Todo ---- .. todo:: This is something we are yet **to do**. Custom Admonitions ------------------ .. admonition:: An admonition of my own making You can create your own admonitions with the accent color. .. admonition:: Example But lots of custom admonition styles are also defined. .. admonition:: Quote The needs of the many outweigh the needs of the few .. admonition:: Bug Bugs weren't always a metaphor .. admonition:: Success Woohoo! .. admonition:: Experimental Experiments are the heart of science Footnotes ========= I have footnoted a first item [#f1]_ and second item [#f2]_. This also references the second item [#f2]_. .. rubric:: Footnotes .. [#f1] My first footnote. .. [#f2] My second footnote. Icons ===== `Font Awesome `_ and `Academicons `_ are both available: .. code-block:: html .. raw:: html Tables ====== Here are some examples of Sphinx `tables `_. Grid ---- A grid table: +------------------------+------------+----------+----------+ | Header1 | Header2 | Header3 | Header4 | +========================+============+==========+==========+ | row1, cell1 | cell2 | cell3 | cell4 | +------------------------+------------+----------+----------+ | row2 ... | ... | ... | | +------------------------+------------+----------+----------+ | ... | ... | ... | | +------------------------+------------+----------+----------+ Simple ------ A simple table: ===== ===== ======= H1 H2 H3 ===== ===== ======= cell1 cell2 cell3 ... ... ... ... ... ... ===== ===== ======= List Tables ----------- .. list-table:: A List Table :header-rows: 1 * - Column 1 - Column 2 * - Item 1 - Item 2 .. list-table:: 50% width list table :header-rows: 1 :width: 50% :widths: 1 4 * - One fifth width column - Four fifths width column * - Item 1 - Item 2 Alignment ~~~~~~~~~ .. list-table:: Left Aligned :header-rows: 1 :align: left * - Column 1 - Column 2 * - Item 1 - Item 2 .. list-table:: Center Aligned :header-rows: 1 :align: center * - Column 1 - Column 2 * - Item 1 - Item 2 .. list-table:: Right Aligned :header-rows: 1 :align: right * - Treat - Quantity * - Albatross - 2.99 * - Crunchy Frog - 1.49 * - Gannet Ripple - 1.99 Code Documentation ================== An example Python function. .. py:function:: format_exception(etype, value, tb[, limit=None]) Format the exception with a traceback. :param etype: exception type :param value: exception value :param tb: traceback object :param limit: maximum number of stack frames to show :type limit: integer or None :rtype: list of strings An example JavaScript function. .. js:class:: MyAnimal(name[, age]) :param string name: The name of the animal :param number age: an optional age for the animal Glossaries ========== .. glossary:: environment A structure where information about all documents under the root is saved, and used for cross-referencing. The environment is pickled after the parsing stage, so that successive runs only need to read and parse new and changed documents. source directory The directory which, including its subdirectories, contains all source files for one Sphinx project. Math ==== .. math:: (a + b)^2 = a^2 + 2ab + b^2 (a - b)^2 = a^2 - 2ab + b^2 .. math:: (a + b)^2 &= (a + b)(a + b) \\ &= a^2 + 2ab + b^2 .. math:: :nowrap: \begin{eqnarray} y & = & ax^2 + bx + c \\ f(x) & = & x^2 + 2xy + y^2 \end{eqnarray} Production Lists ================ .. productionlist:: try_stmt: try1_stmt | try2_stmt try1_stmt: "try" ":" `suite` : ("except" [`expression` ["," `target`]] ":" `suite`)+ : ["else" ":" `suite`] : ["finally" ":" `suite`] try2_stmt: "try" ":" `suite` : "finally" ":" `suite`