##############################
Using Sphinx
##############################

*****************
reStructuredText
*****************

Roles
=====

Sphinx uses interpreted text roles to insert semantic markup into documents. They are written as ``:rolename:`content```.

The default role (``content``) has no special meaning by default. You are free to use it for anything you like, e.g. variable names; use the default_role config value to set it to a known role – the ``any`` role to find anything or the ``py:obj`` role to find Python objects are very useful for this.

Cross-referencing syntax
---------------------------

Cross-references are generated by many semantic interpreted text roles. Basically, you only need to write ``:role:`target```, and a link will be created to the item named target of the type indicated by role. The link’s text will be the same as target.

Cross-referencing ojbects:
^^^^^^^^^^^^^^^^^^^^^^^^^^

These roles are described with their respective domains:

- Python
- C
- C++
- JavaScript
- ReST