Documentation for CUBRID RDBMS
-
Extension of original files of this manual
*.rst *.inc
-
Precaution to edit files.
Please don't use tab character. Change your editor setting that "change tab as spaces". 1 tab should be 4 spaces.
-
How to build manual
-
Install sphinx package and theme
-
Install python
yum install python3 -y
-
Install read the docs theme
pip3 install sphinx_rtd_theme
-
Install make to build
yum install make -y
-
-
go to the manual directory (cd ko for Korean; or cd en for English)
-
make html
-
now you can see the built html files from _built/
-
-
Make commands
make clean
make html
-
Mainly used tags on sphinx document(.rst file).
Basically, indent is very important when you use tags. For details, see http://sphinx-doc.org/
- Titles
***** First ***** Second ====== Third ----- Fourth ^^^^^^ Fifth +++++
- bold & italic
**bold text** *italic text*
- escaping with \
*italic text*\_ will be "italic text_" : blank is ignored.
- dot list
* text - text
- boxes
:: text
.. code-block:: sql SELECT 1;
.. note:: note this.
.. warning:: warning this.
- footnote
.. rubric:: Footnotes .. [#f1] word: explanation
- function
.. function:: function_name (arg1, arg2)
- option
.. program:: program_name .. option:: option_description explanation
-
links
-
function link
:func:`func_name`
-
footnote link
[#f1]_
-
internal link
.. _link_position: :ref:`link_positon` or :ref:`title <link_positon>` :doc:`doc_path_name`
-
external link
`title <http address>`_
-