cras_docs_common.sphinx_docs_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 = os.getenv('CRAS_DOCS_COMMON_SPHINX_PACKAGE_PATH', 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'
	custom_theme_path = os.getenv('CRAS_DOCS_COMMON_SPHINX_THEME_PATH', None)
string	default_role = 'code'
list	extensions
dictionary	extlinks
	html_theme = os.getenv('CRAS_DOCS_COMMON_SPHINX_HTML_THEME', 'cras-theme')
list	html_theme_path = [theme_path, catkin_sphinx.get_theme_path()]
string	independent_api = ros_api_base % "independent"
dictionary	intersphinx_mapping
string	master_doc = 'index'
string	melodic_api = ros_api_base % "melodic"
	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	ros_wiki_base = 'https://wiki.ros.org/'
string	rst_epilog
	theme_path = os.path.join(this_dir, 'sphinx-themes')
	this_dir = os.path.abspath(os.path.dirname(os.path.abspath(__file__)))
	version = catkin_package.version

Function Documentation

ros_msg_reference()

def cras_docs_common.sphinx_docs_conf.ros_msg_reference	(		app,
			env,
			node,
			contnode
	)

Definition at line 121 of file sphinx_docs_conf.py.

setup()

def cras_docs_common.sphinx_docs_conf.setup

(

app

)

Definition at line 142 of file sphinx_docs_conf.py.

Variable Documentation

author

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

Definition at line 37 of file sphinx_docs_conf.py.

autoclass_content

string cras_docs_common.sphinx_docs_conf.autoclass_content = 'both'

Definition at line 58 of file sphinx_docs_conf.py.

catkin_dir

cras_docs_common.sphinx_docs_conf.catkin_dir = os.getenv('CRAS_DOCS_COMMON_SPHINX_PACKAGE_PATH', dirname(dirname(abspath(__file__))))

Definition at line 32 of file sphinx_docs_conf.py.

catkin_package

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

Definition at line 33 of file sphinx_docs_conf.py.

copyright

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

Definition at line 36 of file sphinx_docs_conf.py.

custom_theme_path

cras_docs_common.sphinx_docs_conf.custom_theme_path = os.getenv('CRAS_DOCS_COMMON_SPHINX_THEME_PATH', None)

Definition at line 67 of file sphinx_docs_conf.py.

default_role

string cras_docs_common.sphinx_docs_conf.default_role = 'code'

Definition at line 60 of file sphinx_docs_conf.py.

extensions

list cras_docs_common.sphinx_docs_conf.extensions

Initial value:

=  [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.extlinks',
    'catkin_sphinx.ShLexer',
    'catkin_sphinx.cmake',
]

Definition at line 43 of file sphinx_docs_conf.py.

extlinks

dictionary cras_docs_common.sphinx_docs_conf.extlinks

Initial value:

=  {
    'ros': (ros_api + '%s', None),
    'roswiki': (ros_wiki_base + '%s?distro=' + ros_distro, ''),
    'rospy:class': (melodic_api + 'rospy/html/rospy.%s-class.html', "rospy."),
    'rospy:fn': (melodic_api + 'rospy/html/rospy-module.html#%s', "rospy."),
    'catkin_pkg': (independent_api + 'catkin_pkg/html/%s', None),
    'rosdep': (independent_api + 'rosdep/html/%s', None),
    'rospkg': (independent_api + 'rospkg/html/%s', None),
    'dynamic_reconfigure': (ros_api + 'dynamic_reconfigure/html/msg/%s.html', "dynamic_reconfigure/"),
}

Definition at line 92 of file sphinx_docs_conf.py.

html_theme

cras_docs_common.sphinx_docs_conf.html_theme = os.getenv('CRAS_DOCS_COMMON_SPHINX_HTML_THEME', 'cras-theme')

Definition at line 72 of file sphinx_docs_conf.py.

html_theme_path

list cras_docs_common.sphinx_docs_conf.html_theme_path = [theme_path, catkin_sphinx.get_theme_path()]

Definition at line 65 of file sphinx_docs_conf.py.

independent_api

string cras_docs_common.sphinx_docs_conf.independent_api = ros_api_base % "independent"

Definition at line 90 of file sphinx_docs_conf.py.

intersphinx_mapping

dictionary cras_docs_common.sphinx_docs_conf.intersphinx_mapping

Initial value:

=  {
    "numpy": ("https://numpy.org/doc/stable/", None),
    "genpy": (ros_api + "genpy/html", None),
}

Definition at line 110 of file sphinx_docs_conf.py.

master_doc

string cras_docs_common.sphinx_docs_conf.master_doc = 'index'

Definition at line 57 of file sphinx_docs_conf.py.

melodic_api

string cras_docs_common.sphinx_docs_conf.melodic_api = ros_api_base % "melodic"

Definition at line 89 of file sphinx_docs_conf.py.

project

cras_docs_common.sphinx_docs_conf.project = catkin_package.name

Definition at line 35 of file sphinx_docs_conf.py.

python_version

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

Definition at line 117 of file sphinx_docs_conf.py.

release

cras_docs_common.sphinx_docs_conf.release = catkin_package.version

Definition at line 39 of file sphinx_docs_conf.py.

rolename

cras_docs_common.sphinx_docs_conf.rolename

Definition at line 140 of file sphinx_docs_conf.py.

ros_api

string cras_docs_common.sphinx_docs_conf.ros_api = ros_api_base % ros_distro

Definition at line 88 of file sphinx_docs_conf.py.

ros_api_base

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

Definition at line 75 of file sphinx_docs_conf.py.

ros_distro

cras_docs_common.sphinx_docs_conf.ros_distro = os.getenv('ROS_DISTRO', 'latest')

Definition at line 74 of file sphinx_docs_conf.py.

ros_wiki_base

string cras_docs_common.sphinx_docs_conf.ros_wiki_base = 'https://wiki.ros.org/'

Definition at line 76 of file sphinx_docs_conf.py.

rst_epilog

string cras_docs_common.sphinx_docs_conf.rst_epilog

Initial value:

=  """
.. |project| replace:: {}
.. |description| replace:: {}
.. role:: raw-html(raw)
   :format: html
 
.. |wiki| replace:: :raw-html:`<a href="{}{}?distro={}">ROS wiki entry</a>`
""".format(project, catkin_package.description, ros_wiki_base, project, ros_distro)

Definition at line 79 of file sphinx_docs_conf.py.

theme_path

cras_docs_common.sphinx_docs_conf.theme_path = os.path.join(this_dir, 'sphinx-themes')

Definition at line 63 of file sphinx_docs_conf.py.

this_dir

cras_docs_common.sphinx_docs_conf.this_dir = os.path.abspath(os.path.dirname(os.path.abspath(__file__)))

Definition at line 62 of file sphinx_docs_conf.py.

version

cras_docs_common.sphinx_docs_conf.version = catkin_package.version

Definition at line 38 of file sphinx_docs_conf.py.