git commit -m "first commit"
This commit is contained in:
67
navigations/geographic_info/geodesy/doc/CHANGELOG.rst
Executable file
67
navigations/geographic_info/geodesy/doc/CHANGELOG.rst
Executable file
@@ -0,0 +1,67 @@
|
||||
Change history
|
||||
==============
|
||||
|
||||
0.5.3 (2018-03-27)
|
||||
------------------
|
||||
|
||||
0.5.2 (2017-04-15)
|
||||
------------------
|
||||
|
||||
0.5.1 (2017-04-15)
|
||||
------------------
|
||||
|
||||
0.5.0 (2017-04-07)
|
||||
------------------
|
||||
|
||||
* Removed Python setup install_requires option.
|
||||
|
||||
0.4.0 (2014-09-18)
|
||||
------------------
|
||||
|
||||
* Released to Indigo.
|
||||
* Remove deprecated geodesy.gen_uuid module (`#4`_).
|
||||
|
||||
0.3.2 (2014-08-30)
|
||||
------------------
|
||||
|
||||
* Released to Indigo.
|
||||
* Make C++ template declaration for WGS-84 header compatible with GCC
|
||||
4.7 compiler (`#12`_), thanks to Mike Purvis and Dirk Thomas.
|
||||
|
||||
0.3.1 (2013-10-03)
|
||||
------------------
|
||||
|
||||
* Fix ROS Hydro header install problem (`#9`_).
|
||||
|
||||
0.3.0 (2013-08-03)
|
||||
------------------
|
||||
|
||||
* Released to Hydro.
|
||||
* Convert to catkin build (`#3`_).
|
||||
* Remove unnecessary roscpp and rospy dependencies (`#6`_).
|
||||
|
||||
0.2.1 (2012-08-13)
|
||||
------------------
|
||||
|
||||
* Released to Fuerte.
|
||||
* Released to Groovy: 2013-03-27.
|
||||
* Use unique_identifier for UUID interfaces.
|
||||
|
||||
0.2.0 (2012-06-02)
|
||||
------------------
|
||||
|
||||
* Many new mapping messages and services added.
|
||||
* Use PROJ.4 library for Python geodesy API (C++ API not ported to
|
||||
PROJ.4 yet).
|
||||
* Released to Electric.
|
||||
|
||||
0.1.0 (2012-04-10)
|
||||
------------------
|
||||
|
||||
* Initial release to Electric.
|
||||
|
||||
.. _`#3`: https://github.com/ros-geographic-info/geographic_info/issues/3
|
||||
.. _`#4`: https://github.com/ros-geographic-info/geographic_info/issues/4
|
||||
.. _`#6`: https://github.com/ros-geographic-info/geographic_info/issues/6
|
||||
.. _`#9`: https://github.com/ros-geographic-info/geographic_info/issues/9
|
||||
.. _`#12`: https://github.com/ros-geographic-info/geographic_info/issues/12
|
||||
251
navigations/geographic_info/geodesy/doc/conf.py
Executable file
251
navigations/geographic_info/geodesy/doc/conf.py
Executable file
@@ -0,0 +1,251 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# geodesy documentation build configuration file, created by
|
||||
# sphinx-quickstart on Wed Apr 25 16:01:20 2012.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
## get catkin package information
|
||||
import os
|
||||
import catkin_pkg.package
|
||||
catkin_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||
catkin_package = catkin_pkg.package.parse_package(
|
||||
os.path.join(catkin_dir, catkin_pkg.package.PACKAGE_MANIFEST_FILENAME))
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'geodesy'
|
||||
copyright = u'2012, Jack O\'Quin'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = catkin_package.version
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = catkin_package.version
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'geodesydoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||
latex_documents = [
|
||||
('index', 'geodesy.tex', u'geodesy Documentation',
|
||||
u'Jack O\'Quin', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'geodesy', u'geodesy Documentation',
|
||||
[u'Jack O\'Quin'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output ------------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'geodesy', u'geodesy Documentation',
|
||||
u'Jack O\'Quin', 'geodesy', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
5
navigations/geographic_info/geodesy/doc/geodesy.bounding_box.rst
Executable file
5
navigations/geographic_info/geodesy/doc/geodesy.bounding_box.rst
Executable file
@@ -0,0 +1,5 @@
|
||||
geodesy.bounding_box
|
||||
--------------------
|
||||
|
||||
.. automodule:: geodesy.bounding_box
|
||||
:members:
|
||||
21
navigations/geographic_info/geodesy/doc/geodesy.gen_uuid.rst
Executable file
21
navigations/geographic_info/geodesy/doc/geodesy.gen_uuid.rst
Executable file
@@ -0,0 +1,21 @@
|
||||
geodesy.gen_uuid
|
||||
----------------
|
||||
|
||||
.. module:: geodesy.gen_uuid
|
||||
|
||||
Generate UUIDs for Geographic Information messages.
|
||||
|
||||
.. deprecated:: 0.3.0
|
||||
|
||||
*This module was removed with version 0.4.0 in ROS Indigo.*
|
||||
|
||||
Instead, use the `unique_id`_ package, which has been stable and
|
||||
available since ROS Fuerte:
|
||||
|
||||
* ``geodesy.gen_uuid.generate(url, id)`` becomes
|
||||
``unique_id.fromURL(url+str(id))``
|
||||
|
||||
* ``geodesy.gen_uuid.makeUniqueID(url, id)`` becomes
|
||||
``unique_id.toMsg(unique_id.fromURL(url+str(id)))``
|
||||
|
||||
.. _`unique_id`: http://wiki.ros.org/unique_id
|
||||
5
navigations/geographic_info/geodesy/doc/geodesy.props.rst
Executable file
5
navigations/geographic_info/geodesy/doc/geodesy.props.rst
Executable file
@@ -0,0 +1,5 @@
|
||||
geodesy.props
|
||||
-------------
|
||||
|
||||
.. automodule:: geodesy.props
|
||||
:members:
|
||||
5
navigations/geographic_info/geodesy/doc/geodesy.utm.rst
Executable file
5
navigations/geographic_info/geodesy/doc/geodesy.utm.rst
Executable file
@@ -0,0 +1,5 @@
|
||||
geodesy.utm
|
||||
-----------
|
||||
|
||||
.. automodule:: geodesy.utm
|
||||
:members:
|
||||
5
navigations/geographic_info/geodesy/doc/geodesy.wu_point.rst
Executable file
5
navigations/geographic_info/geodesy/doc/geodesy.wu_point.rst
Executable file
@@ -0,0 +1,5 @@
|
||||
geodesy.wu_point
|
||||
----------------
|
||||
|
||||
.. automodule:: geodesy.wu_point
|
||||
:members:
|
||||
22
navigations/geographic_info/geodesy/doc/index.rst
Executable file
22
navigations/geographic_info/geodesy/doc/index.rst
Executable file
@@ -0,0 +1,22 @@
|
||||
.. geodesy documentation master file, created by
|
||||
sphinx-quickstart on Wed Apr 25 16:01:20 2012.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
geodesy: Python APIs for Geographic coordinates
|
||||
===============================================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:glob:
|
||||
|
||||
geodesy.*
|
||||
CHANGELOG
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
Reference in New Issue
Block a user