mirror of
https://github.com/ThePhD/sol2.git
synced 2024-03-22 13:10:44 +08:00
115 lines
3.8 KiB
ReStructuredText
115 lines
3.8 KiB
ReStructuredText
.. Sphinx RTD theme demo documentation master file, created by
|
|
sphinx-quickstart on Sun Nov 3 11:56:36 2013.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to Sphinx RTD theme demo's documentation!
|
|
=================================================
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
This is a test. Here is an equation:
|
|
:math:`X_{0:5} = (X_0, X_1, X_2, X_3, X_4)`.
|
|
Here is another:
|
|
|
|
.. math::
|
|
|
|
\nabla^2 f =
|
|
\frac{1}{r^2} \frac{\partial}{\partial_r}
|
|
\left( r^2 \frac{\partial f}{\partial_r} \right) +
|
|
\frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial_\theta}
|
|
\left( \sin \theta \, \frac{\partial f}{\partial_\theta} \right) +
|
|
\frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial_\phi^2}
|
|
|
|
API Test
|
|
========
|
|
|
|
.. automodule:: test_py_module.test
|
|
:members:
|
|
:private-members:
|
|
:special-members:
|
|
|
|
Code test
|
|
=========
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"windows": [
|
|
{
|
|
"panes": [
|
|
{
|
|
"shell_command": [
|
|
"echo 'did you know'",
|
|
"echo 'you can inline'"
|
|
]
|
|
},
|
|
{
|
|
"shell_command": "echo 'single commands'"
|
|
},
|
|
"echo 'for panes'"
|
|
],
|
|
"window_name": "long form"
|
|
}
|
|
],
|
|
"session_name": "shorthands"
|
|
}
|
|
|
|
Sidebar
|
|
=======
|
|
|
|
.. sidebar:: Ch'ien / The Creative
|
|
|
|
.. image:: static/yi_jing_01_chien.jpg
|
|
|
|
*Above* CH'IEN THE CREATIVE, HEAVEN
|
|
|
|
*Below* CH'IEN THE CREATIVE, HEAVEN
|
|
|
|
The first hexagram is made up of six unbroken lines. These unbroken lines stand for the primal power, which is light-giving, active, strong, and of the spirit. The hexagram is consistently strong in character, and since it is without weakness, its essence is power or energy. Its image is heaven. Its energy is represented as unrestricted by any fixed conditions in space and is therefore conceived of as motion. Time is regarded as the basis of this motion. Thus the hexagram includes also the power of time and the power of persisting in time, that is, duration.
|
|
|
|
The power represented by the hexagram is to be interpreted in a dual sense in terms of its action on the universe and of its action on the world of men. In relation to the universe, the hexagram expresses the strong, creative action of the Deity. In relation to the human world, it denotes the creative action of the holy man or sage, of the ruler or leader of men, who through his power awakens and develops their higher nature.
|
|
|
|
Boxes
|
|
=====
|
|
|
|
.. note::
|
|
Equations within a note
|
|
:math:`G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})`.
|
|
|
|
.. warning::
|
|
Equations within a note
|
|
:math:`G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})`.
|
|
|
|
|
|
Inline code and references
|
|
==========================
|
|
|
|
`reStructuredText`_ is a markup language. It can use roles and
|
|
declarations to turn reST into HTML.
|
|
|
|
In reST, ``*hello world*`` becomes ``<em>hello world</em>``. This is
|
|
because a library called `Docutils`_ was able to parse the reST and use a
|
|
``Writer`` to output it that way.
|
|
|
|
If I type ````an inline literal```` it will wrap it in ``<tt>``. You can
|
|
see more details on the `Inline Markup`_ on the Docutils homepage.
|
|
|
|
Also with ``sphinx.ext.autodoc``, which I use in the demo, I can link to
|
|
:class:`test_py_module.test.Foo`. It will link you right my code
|
|
documentation for it.
|
|
|
|
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
|
.. _Docutils: http://docutils.sourceforge.net/
|
|
.. _Inline Markup: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup
|
|
|
|
Citation
|
|
========
|
|
|
|
Here I am making a citation [1]_
|
|
|
|
.. [1] This is the citation I made, let's make this extremely long so that we can tell that it doesn't follow the normal responsive table stuff.
|