From d91b671798125fd4889914d92a29cf0f7a5fef21 Mon Sep 17 00:00:00 2001 From: Sameer Agarwal Date: Wed, 6 Feb 2013 01:08:40 -0800 Subject: [PATCH] More small changes More small changes to the docs. 1. Better landing page. 2. Minor tweaks to the side bar. 3. Reference to more example code. 4. Local MathJax references. Change-Id: I39b9436dc2803732a875bbbee7f15802c4934031 --- docs/source/_themes/armstrong/globaltoc.html | 2 +- docs/source/conf.py | 9 ++++--- docs/source/index.rst | 26 ++++++++++++++++--- docs/source/license.rst | 4 +-- docs/source/tutorial.rst | 27 ++++++++++++++++++++ 5 files changed, 58 insertions(+), 10 deletions(-) diff --git a/docs/source/_themes/armstrong/globaltoc.html b/docs/source/_themes/armstrong/globaltoc.html index 8fd1879c3..20d864131 100644 --- a/docs/source/_themes/armstrong/globaltoc.html +++ b/docs/source/_themes/armstrong/globaltoc.html @@ -7,5 +7,5 @@ :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} -

{{ _('Contents') }}

+

{{ _('Ceres Solver') }}

{{ toctree() }} diff --git a/docs/source/conf.py b/docs/source/conf.py index 174f27218..35b2e510e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -103,7 +103,7 @@ html_theme_path = ["_themes",] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = "The Ceres Solver Manual" +html_title = "Ceres Solver" # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None @@ -166,6 +166,7 @@ html_show_copyright = True # Output file base name for HTML help builder. htmlhelp_basename = 'CeresSolverdoc' +mathjax_path = "mathjax/MathJax.js?config=TeX-AMS_HTML" # -- Options for LaTeX output -------------------------------------------------- @@ -183,7 +184,7 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'CeresSolver.tex', u'The Ceres Solver Manual', + ('index', 'CeresSolver.tex', u'Ceres Solver', u'Sameer Agarwal \\& Keir Mierle', 'manual'), ] @@ -213,7 +214,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'ceressolver', u'The Ceres Solver Manual', + ('index', 'ceressolver', u'Ceres Solver', [u'Sameer Agarwal & Keir Mierle'], 1) ] @@ -227,7 +228,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'CeresSolver', u'The Ceres Solver Manual', + ('index', 'CeresSolver', u'Ceres Solver', u'Sameer Agarwal & Keir Mierle', 'CeresSolver', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/source/index.rst b/docs/source/index.rst index e6ea8efeb..2b9b8f673 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,12 +3,32 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -======== -Contents -======== +============ +Ceres Solver +============ + +Ceres Solver is a portable C++ library for solving non-linear least +squares problems. + +* Download the latest stable `release + `_ + or clone the `repository + `_ + +* Read the :ref:`chapter-tutorial` + +* Browse the :ref:`chapter-modeling` and :ref:`chapter-solving` + +* Ask questions and join the discussion on the `mailing list + `_. + +* File bugs, feature requests in the `issue tracker + `_. + .. toctree:: :maxdepth: 1 + :hidden: introduction building diff --git a/docs/source/license.rst b/docs/source/license.rst index 3c962e13b..9e99cc74e 100644 --- a/docs/source/license.rst +++ b/docs/source/license.rst @@ -29,8 +29,8 @@ liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage. -Citing Ceres Solver -=================== +Citation +======== If you use Ceres Solver for an academic publication, please cite this manual. e.g., :: diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst index a8ffc31ee..82e38f124 100644 --- a/docs/source/tutorial.rst +++ b/docs/source/tutorial.rst @@ -559,3 +559,30 @@ solvers, robust loss functions and local parameterizations see .. rubric:: Footnotes .. [#f5] The full source code for this example can be found in ``examples/simple_bundle_adjuster.cc``. + + +Other Examples +============== + +Besides the examples in this chapter, the `example +`_ +directory contains a number of other examples: + +#. `circle_fit.cc + `_ + shows how to fit data to a circle. + +#. `nist.cc + `_ + implements and attempts to solves the `NIST + `_ + non-linear regression problems. + +#. `denoising.cc + `_ + implements image denoising using the `Fields of Experts + `_ + model. + + +