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
diff --git a/docs/source/_themes/armstrong/globaltoc.html b/docs/source/_themes/armstrong/globaltoc.html
index 8fd1879..20d8641 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.
#}
-<h3><a href="{{ pathto(master_doc) }}">{{ _('Contents') }}</a></h3>
+<h3><a href="{{ pathto(master_doc) }}">{{ _('Ceres Solver') }}</a></h3>
{{ toctree() }}
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 174f272..35b2e51 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -103,7 +103,7 @@
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> 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 @@
# 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 @@
# 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 @@
# 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 @@
# (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 e6ea8ef..2b9b8f6 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
+ <https://ceres-solver.googlecode.com/files/ceres-solver-1.4.0.tar.gz>`_
+ or clone the `repository
+ <https://ceres-solver.googlesource.com/ceres-solver>`_
+
+* Read the :ref:`chapter-tutorial`
+
+* Browse the :ref:`chapter-modeling` and :ref:`chapter-solving`
+
+* Ask questions and join the discussion on the `mailing list
+ <https://groups.google.com/forum/?fromgroups#!forum/ceres-solver>`_.
+
+* File bugs, feature requests in the `issue tracker
+ <https://code.google.com/p/ceres-solver/issues/list>`_.
+
.. toctree::
:maxdepth: 1
+ :hidden:
introduction
building
diff --git a/docs/source/license.rst b/docs/source/license.rst
index 3c962e1..9e99cc7 100644
--- a/docs/source/license.rst
+++ b/docs/source/license.rst
@@ -29,8 +29,8 @@
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 a8ffc31..82e38f1 100644
--- a/docs/source/tutorial.rst
+++ b/docs/source/tutorial.rst
@@ -559,3 +559,30 @@
.. 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
+<https://ceres-solver.googlesource.com/ceres-solver/+/master/examples/>`_
+directory contains a number of other examples:
+
+#. `circle_fit.cc
+ <https://ceres-solver.googlesource.com/ceres-solver/+/master/examples/circle_fit.cc>`_
+ shows how to fit data to a circle.
+
+#. `nist.cc
+ <https://ceres-solver.googlesource.com/ceres-solver/+/master/examples/nist.cc>`_
+ implements and attempts to solves the `NIST
+ <http://www.itl.nist.gov/div898/strd/nls/nls_main.shtm>`_
+ non-linear regression problems.
+
+#. `denoising.cc
+ <https://ceres-solver.googlesource.com/ceres-solver/+/master/examples/denoising.cc>`_
+ implements image denoising using the `Fields of Experts
+ <http://www.gris.informatik.tu-darmstadt.de/~sroth/research/foe/index.html>`_
+ model.
+
+
+
