Testpage
This page is for testing purposes. It showcases the reStructuredText markup with its rendered and raw versions for different formats and usecases.
See also
Sphinx Docs Sphinx Primer
Sphinx Docs TOC
DocUtils Overview
Metadata Test
Each page should have its own metadata to have a descent intro on the searchengines and if links are shared.
.. meta::
:description lang=en: Particl Marketplace is censorship-resistant eCommerce built on blockchain technology and respects your privacy.
Headings Test
This area shows some sample texts. Or an internal link to a certain page like the Particl Support Page n other than that we have some roles like emphasis strong literal and so on. It is even possible to reference a link: Make me laugh or to reference to a heading on this page like Video or Images but you can also reference another page like this
First heading
Bodytext Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Second heading
Bodytext Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Third heading
Bodytext Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Fourth heading
Bodytext Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Headings
--------
This area shows some sample texts. Or an internal link to a certain page like the :ref:`Particl Support Page <../faq/get_support>` n other than that we have some roles like *emphasis* **strong** ``literal`` and so on. It is even possible to reference a link: `Make me laugh`_
==============
Document title
==============
use only once in a document
First heading
-------------
Bodytext Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Second heading
~~~~~~~~~~~~~~
Bodytext Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Third heading
^^^^^^^^^^^^^
Bodytext Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
.. _Make me laugh: https://www.youtube.com/watch?v=hY7m5jjJ9mM
1. ========== for the first level
2. ---------- for the second level
3. ~~~~~~~~~~ for the third level
4. """""""""" for the fourth level
5. ''''''''''
6. ^^^^^^^^^^
7. ##########
8. **********
Achievements Test
An achievement can be placed below a task that has been completed.
Congratulations! You have installed Particl Marketplace.
.. rst-class:: achievement
Congratulations! You have installed Particl Marketplace.
Bigmessage
A bigmessage can be placed where it is really needed.
.. rst-class:: bigmessage
bigmessage! Get it while it's hot.
Glossary Test
We have now a glossary file “Glossary” which should be populated with definitions. Then we can reference these definitions like this -> Sphinx or FooBarLoo as I want.
We have now a glossary file :doc:`glossary` which should be populated with definitions. Then we can reference these definitions like this -> :term:`Sphinx`.
You can link to a term in the glossary while showing different text in the topic by including the term in angle brackets. For example:
:term:`FooBarLoo as I want<Sphinx>`
Text Roles
Abbriviation
If the role content contains a parenthesized explanation, it will be treated specially: it will be shown in a tool-tip in HTML, and output only once in LaTeX.
LIFO
:abbr:`LIFO (last-in, first-out)`
File Path
Using a file path
/etc/passwd
:file:`/etc/passwd`
Keystrokes
Mark a sequence of keystrokes
cmd + s || cmd+s followed by y
:kbd:`cmd` + :kbd:`s` || :kbd:`cmd+s` followed by :kbd:`y`
GUI Labels
Using GUI Labels
Cancel, Ok, Reset, FAQ
:guilabel:`&Cancel`, :guilabel:`O&k`, :guilabel:`&Reset`, :guilabel:`FAQ`
inline code
$result = $a + 23;
:code:`$result = $a + 23;`
Subscript and Superscript
subscripted
superscripted
:subscript:`subscripted`
:superscript:`superscripted`
External Links
External referenced link The reference.
* `External inline link <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
* `External referenced link `The reference`_.
.. _The reference: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
Internal Links
Learn how to link to a different section within this document.
* Learn how to :ref:`link to a different section within this document<Tables>`.
.. Mind the non existent gap between the last word and the
To support cross-referencing to arbitrary locations in any document, the standard reST labels are used. For this to work label names must be unique throughout the entire documentation.
I reference to a page under Enable Tor on Particl Desktop
* I reference to a page under :menuselection:`guides --> guide_general_enable_tor.rst` :ref:`Enable Tor on Particl Desktop`
Additionally there is the possibility to define manual reference labels.
.. _my-reference-label:
Section to cross-reference
--------------------------
This is the text of the section.
It refers to the section itself, see :ref:`my-reference-label`.
The referencing works over the whole tree which means targeting at any page as long the reference label is unique.
Cross-referencing documents There is also a way to directly link to documents. Link to the specified document; the document name can be specified in absolute or relative fashion:
* :menuselection:`faq --> common_issues.rst` as relative path :doc:`link text <_templates/../faq/common_issues>`.
* :menuselection:`faq --> common_issues.rst` as absolute path :doc:`link text </faq/common_issues>`.
Download Links
See this image.
See :download:`this image </_static/images/particl-logo-green.png>`.
Video
.. raw:: html
<div style="text-align: center; margin-bottom: 2em;">
<iframe width="100%" height="390" src="https://www.youtube.com/embed/IC9yY3MThoo" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
</div>
Images
.. figure:: /_static/media/images/canvas_w_logo.png
:align: center
:alt: Particl Logo on a dark canvas
:target: /_static/media/images/canvas_w_logo.png
Boxes
Note
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Tip
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Danger
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Attention
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
See also
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Hint
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Important
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
Further technical documentation
You can make up your own admonition too.
.. note::
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
.. tip::
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
.. danger::
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
.. attention::
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
.. warning::
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
.. hint::
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
.. important::
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
.. admonition:: Further technical documentation
You can make up your own admonition too.
Tables
Even csv tables can be put in.
Simple
A simple Table
A |
B |
A and B |
|---|---|---|
False |
False |
False |
True |
False |
False |
False |
True |
False |
True |
True |
True |
===== ===== =======
A B A and B
===== ===== =======
False False False
True False False
False True False
True True True
===== ===== =======
Grid
Header row, column 1 (header rows optional) |
Header 2 |
Header 3 |
Header 4 |
|---|---|---|---|
body row 1, column 1 |
column 2 |
column 3 |
column 4 |
body row 2 |
… |
… |
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+========================+============+==========+==========+
| body row 1, column 1 | column 2 | column 3 | column 4 |
+------------------------+------------+----------+----------+
| body row 2 | ... | ... | |
+------------------------+------------+----------+----------+
CSV
Treat |
Quantity |
Description |
|---|---|---|
Albatross |
2.99 |
On a stick! |
Crunchy Frog |
1.49 |
If we took the bones out, it wouldn’t be crunchy, now would it? |
Gannet Ripple |
1.99 |
On a stick! |
.. csv-table:: Frozen Delights!
:header: "Treat", "Quantity", "Description"
:widths: 15, 10, 30
"Albatross", 2.99, "On a stick!"
"Crunchy Frog", 1.49, "If we took the bones out, it wouldn't be
crunchy, now would it?"
"Gannet Ripple", 1.99, "On a stick!"
Lists
Big fat looking list
Do this and that.
And FooBar of course.
If you know what I mean.
Whatever
Two
$a = 'hello'; $b = 'something';
.. rst-class:: bignums-xxl
1. **Do this and that.**
* And FooBar of course.
* If you know what I mean.
* Whatever
2. Two
.. code-block:: php
$a = 'hello';
$b = 'something';
Nested Normal
sadipscing elitr
- magna aliquyam erat, sed diam
with nesting
if you like
ipsum dolor sit
* sadipscing elitr
* magna aliquyam erat, sed diam
* with nesting
* if you like
* ipsum dolor sit
Manual
sadipscing elitr
magna aliquyam erat, sed diam
ipsum dolor sit
1. sadipscing elitr
2. magna aliquyam erat, sed diam
3. ipsum dolor sit
Automatic
sadipscing elitr
magna aliquyam erat, sed diam
ipsum dolor sit
#. sadipscing elitr
#. magna aliquyam erat, sed diam
#. ipsum dolor sit
Normal
sadipscing elitr
magna aliquyam erat, sed diam
ipsum dolor sit
- sadipscing elitr
- magna aliquyam erat, sed diam
- ipsum dolor sit
Codeblocks
No special highlighting
$ cd ~/myproject
$ foo bar
> kill -9
.. code-block:: none
$ cd ~/myproject
$ foo bar
> kill -9
Bash highlighting
$ cd ~/.particl
$ rm *
.. code-block:: bash
$ cd ~/.particl
$ rm *
HTML highlighting
<h1>code block example</h1>
<p>Paragraph Text</p>
.. code-block:: html
<h1>code block example</h1>
<p>Paragraph Text</p>
Tabs
Grouped tabs
Linux Line 1
Mac OSX Line 1
Windows Line 1
Linux Line 1 Linux Line 2
Mac OSX Line 1 Mac OSX Line 2
Windows Line 1 Mac OSX Line 2
.. tabs::
.. group-tab:: Linux
Linux Line 1
.. group-tab:: Mac OSX
Mac OSX Line 1
.. group-tab:: Windows
Windows Line 1
.. tabs::
.. group-tab:: Linux
Linux Line 1
Linux Line 2
.. group-tab:: Mac OSX
Mac OSX Line 1
Mac OSX Line 2
.. group-tab:: Windows
Windows Line 1
Mac OSX Line 2
Normal tabs
c:foobar.bat
cd ~ ls -la whoami
cd ~ ls -la uname -a
.. tabs::
.. tab:: Windows
c:\foo\bar.bat
.. tab:: Mac
cd ~
ls -la
whoami
.. tab:: Linux
cd ~
ls -la
uname -a
Toggles
Toggle items can be used for FAQ like content.
I am a header. Why is particl the best marketplace in the world?
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of THIS
I am a second header. Why is particl the best marketplace in the world?
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of THIS
I am a second header. Why is particl the best marketplace in the world?
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of THIS
I am a second header. Why is particl the best marketplace in the world?
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of THIS
.. container:: toggle
.. container:: header
**I am a header. Why is particl the best marketplace in the world?**
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of **THIS**
.. container:: toggle
.. container:: header
**I am a second header. Why is particl the best marketplace in the world?**
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of **THIS**
Including files
We are able to include files and render them locally. This is very helpful for the FAQ sections as we are able to deliver the FAQ additionally at the place where it might be needed. For the nature that faq do have a repetitve character in certain sections we do not need to write them again and they are always up to date. The naming is important to prevent double rendering.
Embedded FAQ from a file 1
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of THIS
Embedded FAQ from a file 2
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of THIS
Embedded FAQ from a file 2
Because Particl is the best thing you will every see in your entire life. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
And because of THIS
.. include:: /faq/faq_testpage.rst.txt
Epilogs
I am a text and int the middle of it I put a link |Courage Cat| out of the epilog. Guess what Particl Marketplace is?
epilog data is put into conf.py
I am a text and int the middle of it I put a link |Courage Cat| out of the epilog. Guess what |PM| is?