conf Namespace Reference

Functions
def	ros_msg_reference (app, env, node, contnode)
def	setup (app)

Variables
string	author = ", ".join([a.name for a in catkin_package.authors])
string	autoclass_content = 'both'
	catkin_dir = dirname(dirname(abspath(__file__)))
	catkin_package = catkin_pkg.package.parse_package(join(catkin_dir, catkin_pkg.package.PACKAGE_MANIFEST_FILENAME))
string	copyright = time.strftime("%Y") + ', Czech Technical University in Prague'
list	extensions
dictionary	extlinks
string	html_theme = 'ros-theme'
list	html_theme_path = [catkin_sphinx.get_theme_path()]
dictionary	intersphinx_mapping
string	master_doc = 'index'
	project = catkin_package.name
string	python_version = '{}.{}'.format(sys.version_info.major, sys.version_info.minor)
	release = catkin_package.version
	rolename
string	ros_api = ros_api_base % ros_distro
string	ros_api_base = 'https://docs.ros.org/en/%s/api/'
	ros_distro = os.getenv('ROS_DISTRO', 'latest')
string	source_suffix = '.rst'
list	templates_path = ['_templates']
	version = catkin_package.version

Function Documentation

ros_msg_reference()

def conf.ros_msg_reference	(		app,
			env,
			node,
			contnode
	)

Definition at line 60 of file conf.py.

setup()

def conf.setup

(

app

)

Definition at line 90 of file conf.py.

Variable Documentation

author

string conf.author = ", ".join([a.name for a in catkin_package.authors])

Definition at line 16 of file conf.py.

autoclass_content

string conf.autoclass_content = 'both'

Definition at line 57 of file conf.py.

catkin_dir

conf.catkin_dir = dirname(dirname(abspath(__file__)))

Definition at line 11 of file conf.py.

catkin_package

conf.catkin_package = catkin_pkg.package.parse_package(join(catkin_dir, catkin_pkg.package.PACKAGE_MANIFEST_FILENAME))

Definition at line 12 of file conf.py.

copyright

string conf.copyright = time.strftime("%Y") + ', Czech Technical University in Prague'

Definition at line 15 of file conf.py.

extensions

list conf.extensions

Initial value:

=  ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.extlinks',
              'sphinx.ext.viewcode']

Definition at line 28 of file conf.py.

extlinks

dictionary conf.extlinks

Initial value:

=  {
    'diagnostic_msgs': (ros_api + 'diagnostic_msgs/html/msg/%s.html', 'diagnostic_msgs/'),
}

Definition at line 52 of file conf.py.

html_theme

string conf.html_theme = 'ros-theme'

Definition at line 24 of file conf.py.

html_theme_path

list conf.html_theme_path = [catkin_sphinx.get_theme_path()]

Definition at line 21 of file conf.py.

intersphinx_mapping

dictionary conf.intersphinx_mapping

Initial value:

=  {
    'python': ('https://docs.python.org/{}/'.format(python_version), None),
    'genpy': (ros_api + 'genpy/html', None),
}

Definition at line 47 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 38 of file conf.py.

project

conf.project = catkin_package.name

Definition at line 14 of file conf.py.

python_version

string conf.python_version = '{}.{}'.format(sys.version_info.major, sys.version_info.minor)

Definition at line 46 of file conf.py.

release

conf.release = catkin_package.version

Definition at line 18 of file conf.py.

rolename

conf.rolename

Definition at line 87 of file conf.py.

ros_api

string conf.ros_api = ros_api_base % ros_distro

Definition at line 43 of file conf.py.

ros_api_base

string conf.ros_api_base = 'https://docs.ros.org/en/%s/api/'

Definition at line 42 of file conf.py.

ros_distro

conf.ros_distro = os.getenv('ROS_DISTRO', 'latest')

Definition at line 41 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 35 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 32 of file conf.py.

version

conf.version = catkin_package.version

Definition at line 17 of file conf.py.