Skip to content

Commit 2736498

Browse files
LennonkaLennonka
committed
Add sample Sphinx project
1 parent 9ef8883 commit 2736498

27 files changed

+1016
-2
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
_build
2+
notes*

‎Projekt/Kniha/JednoduchaKapitola.rst

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
..
2+
only:: format_latex
3+
4+
|lpage|
5+
6+
Jednoduchá kapitola
7+
===================
8+
9+
:doc:`Blok <Prvky/Bloky>`\ +
10+
11+
.. only:: extra
12+
13+
:EXTRA: Něco extra!
14+
15+
.. contents:: Lokální obsah
16+
17+
.. :local:
18+
:backlinks: none
19+
20+
Název sekce
21+
-----------
22+
23+
:doc:`Blok <Prvky/Bloky>`\ +
24+
25+
Podsekce
26+
********
27+
28+
:doc:`Blok <Prvky/Bloky>`\ +
29+
30+
Další podsekce
31+
**************
32+
33+
:doc:`Blok <Prvky/Bloky>`\ +
34+
35+
Další sekce
36+
-----------
37+
38+
:doc:`Blok <Prvky/Bloky>`\ +

‎Projekt/Kniha/Kapitola/Sekce1.1.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Sekce 1
2+
=======
3+
4+
Odstavec.

‎Projekt/Kniha/Kapitola/Sekce1.2.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
..
2+
only:: format_latex
3+
4+
|lpage|
5+
6+
Sekce 2
7+
=======
8+
9+
Odstavec.

‎Projekt/Kniha/Kapitola/index.rst

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Složená kapitola
2+
=================
3+
4+
Odstavec.
5+
6+
.. tip:: Vytvořit si pro složenou kapitolu podadresář.
7+
8+
.. only:: extra
9+
10+
:EXTRA: Něco extra!
11+
12+
.. toctree::
13+
:caption: Obsah složené kapitoly
14+
:glob:
15+
16+
Sekce*

‎Projekt/Kniha/Prvky/Bloky.rst

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
Blokové prvky
2+
=============
3+
4+
Blokové prvky mohou být vnořené (\ *nested*).
5+
6+
.. only:: extra
7+
8+
:EXTRA: Něco extra!
9+
10+
.. contents:: Lokální obsah
11+
:local:
12+
:backlinks: none
13+
14+
.. index:: odstavec
15+
16+
Odstavce
17+
--------
18+
19+
Odstavec je základ.
20+
21+
Další odstavec musí být oddělen aslespoň jedním prázdným řádkem.
22+
Odstavce nezachovávají zalomení řádků.
23+
24+
Odstavce mohou obsahovat :doc:`řádkové prvky jako třeba odkaz <Inline>`.
25+
26+
Seznamy
27+
-------
28+
29+
Nečíslovaný seznam: [#lists]_
30+
31+
- A bullet list
32+
33+
+ Nested bullet list.
34+
+ Nested item 2.
35+
36+
- Item 2.
37+
38+
Paragraph 2 of item 2.
39+
40+
* Nested bullet list.
41+
* Nested item 2.
42+
43+
- Third level.
44+
- Item 2.
45+
46+
* Nested item 3.
47+
48+
.. kotva bloku (zde před odstavcem):
49+
50+
.. _cislovany-seznam:
51+
52+
Číslovaný seznam: [#lists]_
53+
54+
1. Arabic numerals.
55+
56+
a) lower alpha)
57+
58+
(i) (lower roman)
59+
60+
A. upper alpha. (po tuto úroveň to zvládne LaTeX)
61+
62+
.. I) upper roman)
63+
64+
2. Lists that don't start at 1:
65+
66+
3. Three
67+
68+
4. Four
69+
70+
C. C
71+
72+
D. D
73+
74+
iii. iii
75+
76+
iv. iv
77+
78+
#. List items may also be auto-enumerated.
79+
80+
.. [#lists] Výsledné odrážkování nebo číslování seznamů závisí na stylu
81+
výstupního formátu.
82+
83+
Obrázky
84+
--------
85+
86+
Obrázek |obr| na řádku pomocí substituce (viz `Epilog`_).
87+
88+
Obrázek obyčejný (image):
89+
90+
.. image:: /obrazky/obrazek.png
91+
:scale: 80 %
92+
93+
.. only:: format_latex
94+
95+
|lpage|
96+
97+
Obrázek s titulkem (figure):
98+
99+
.. figure:: /obrazky/obrazek.png
100+
:align: center
101+
:scale: 50 %
102+
103+
Titulek
104+
105+
A legenda, ve které můžou být další bloky, např.
106+
107+
* seznam
108+
109+
110+
Tabulky
111+
--------
112+
113+
* Implicitní (ASCII), viz `Grid and Simple Table
114+
<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#tables>`_
115+
* Explicitní (direktivy), viz `CSV and List Table
116+
<http://docutils.sourceforge.net/docs/ref/rst/directives.html#tables>`_
117+
118+
Jednoduchá tabulka pomocí seznamu (list table):
119+
120+
.. LaTeX: určení šířky sloupců (musí být těsně před tabulkou)
121+
122+
.. tabularcolumns:: |p{0.15\textwidth}|p{0.79\textwidth}|
123+
.. list-table::
124+
:header-rows: 1
125+
:widths: 20, 80
126+
127+
* - Název
128+
- Identifikátor
129+
* - Funkce
130+
- \urn:my:python:func
131+
* - Proměnná
132+
- \urn:my:python:var
133+
* - Modul
134+
- \urn:my:python:mod
135+
136+
Výpis kódu
137+
----------
138+
139+
.. code-block:: Python
140+
:caption: Příklad definice funkce
141+
:linenos:
142+
143+
def print_greeting(greeting):
144+
print(greeting)
145+
146+
print_greeting("Hello World!")
147+
148+
Upozornění (admonitions)
149+
------------------------
150+
151+
.. Warning:: Pokud odpojíte disk z elektřiny, můžete přijít o data!
152+
153+
.. Important:: Po prvním přihlášení si změňte heslo!
154+
155+
.. Note:: Blokové prvky mohou být vnořené, je potřeba si ohlídat odsazení.
156+
157+
Jako třeba tady.
158+
159+
.. Tip:: To si zapište za uši.
160+
161+
Surový obsah
162+
------------
163+
164+
.. only:: format_html
165+
166+
HTML výstup:
167+
168+
.. raw:: html
169+
170+
<hr width=50 size=10>
171+
172+
.. only:: format_latex
173+
174+
LaTeX výstup:
175+
176+
.. raw:: latex
177+
178+
\rule{0.5cm}{0.5cm}
179+
180+
Surová data lze i načíst ze souboru::
181+
182+
.. raw:: html
183+
:file: inclusion.html
184+
185+
186+
Epilog
187+
------
188+
189+
Substituce obrázku (definice nic neprodukuje)
190+
191+
.. |obr| image:: /obrazky/ikona16.png

‎Projekt/Kniha/Prvky/Inline.rst

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
Řádkové prvky
2+
=============
3+
4+
V textu můžete *slabě* nebo **silně** zvýraznit úseky textu.
5+
Dokonce i v rámci jednoho slova, např. re\ **Structured**\ Text.
6+
Když potřebujete hvězdičku nebo jiný řídící znak, tak použijte zpětné lomítko
7+
k odescapování, např.: ``\*`` -> \*
8+
9+
Když vás nebaví opakovaně psát něco tak dlouhého jako je |rst|,
10+
použijte substituci [#pozn]_ (odkaz na poznámku pod čarou).
11+
12+
.. only:: extra
13+
14+
:EXTRA: Něco extra!
15+
16+
Základní
17+
--------
18+
19+
.. list-table::
20+
:header-rows: 1
21+
22+
* - Název
23+
- Implicitní zápis
24+
- Explicitní zápis
25+
- Výstup
26+
* - Literál/kód
27+
- ````print()````
28+
- ``:code:`print()```
29+
- :code:`print()`
30+
* - Slabé zvýraznění
31+
- ``*slabé*``
32+
- ``:emphasis:`slabé```
33+
- :emphasis:`slabé`
34+
* - Silné zvýraznění
35+
- ``**silné**``
36+
- ``:strong:`silné```
37+
- :strong:`silné`
38+
* - Dolní index (subscript)
39+
- ---
40+
- ``H\ :sub:`2`\ O``
41+
- H\ :sub:`2`\ O
42+
* - Horní index (superscript)
43+
- ---
44+
- ``2\ :sup:`8` = 256``
45+
- 2\ :sup:`8` = 256
46+
47+
48+
Odkazy a reference
49+
------------------
50+
51+
Implicitní:
52+
53+
* parsované z URI
54+
- URL http://example.com
55+
- URN urn:my:python:mod
56+
* `Example.com <http://example.com>`_ (externí odkaz)
57+
* `Řádkové prvky`_ (lokální nadpis)
58+
59+
Explicitní -- role:
60+
61+
* ``:ref:`identifikator-kotvy```, ``:ref:`popisek <identifikator-kotvy>```
62+
- např. :ref:`odkaz na odstavec <cislovany-seznam>`
63+
* ``:doc:`/Cesta/k/Dokumentu```, ``:doc:`popisek </Cesta/k/Dokumentu>```
64+
- např. :doc:`odkaz na hlavní stránku dokumentace </index>`
65+
66+
Sémantika
67+
----------
68+
69+
Odkaz do slovníku: ``:term:`pojem``` -> :term:`pojem`
70+
71+
Zkratka: ``:abbr:`LIFO (last-in, first-out)``` -> :abbr:`LIFO (last-in, first-out)`
72+
73+
Cesta k souboru: ``:file:`/usr/lib/python2.{x}/site-packages``` -> :file:`/usr/lib/python2.{x}/site-packages`
74+
75+
Popisek v GUI: ``:guilabel:`Odeslat``` -> :guilabel:`Odeslat`
76+
77+
Výběr z menu: ``:menuselection:`Menu --> Submenu --> Item``` -> :menuselection:`Menu --> Submenu --> Item`
78+
79+
A mnoho dalších.
80+
81+
Epilog
82+
------
83+
84+
Substituce textu (definice nic neprodukuje)
85+
86+
.. |rst| replace:: reStructuredText
87+
88+
Poznámka pod čarou (definice)
89+
90+
.. [#pozn] Substituce musí být definována lokálně, je jedno kde.
91+
92+
Poznámka pod čarou v HTML zůstane na místě, kde byla uvedena její definice.

0 commit comments

Comments
 (0)