Commit Graph

13 Commits

Author SHA1 Message Date
Sameer Agarwal 5a30cae583 Preparing for 2.2.0rc1
1. Add a version history
2. Update copyright years across the code base
3. Run format_all.sh
4. Update version strings from 2.1.0 to 2.2.0 in the docs and
   elsewhere.

Change-Id: I46d8d479d54bd6002d532785e67342106e73c9ac
2023-09-21 11:23:38 -07:00
Sameer Agarwal 0141ca090c Deprecate LocalParameterizations
Add [[deprecate]] notices to everything LocalParameterization
related.

Make sure that Ceres can be compiled without triggering
deprecation warnings.

Update the documentation:

a. Add deprecation notices.
b. Document interaction between LocalParameterization and Manifold
   coexisting in the Problem.
c. Add documentation for Manifold(s)

Change-Id: Ie4ad48963c83fded86e533c8c60561af402fbaff
2022-02-10 06:36:47 -08:00
Sameer Agarwal 70308f7bb9 Simplify documentation generation.
1. The MathJax font configuration is moved into conf.py and removed
from make_docs.py along with better font sizing.
2. Remove the bread crumb replacement as it is not working anymore.
3. Fix a parsing error in nnls_modeling.rst which the new version of
sphinx barfed on.

Change-Id: Ia3c2e732323a8b5cabafe851ac5ca0f0c82da071
2020-05-27 19:24:46 +00:00
Sameer Agarwal d1e954d246 Minor changes to the documentation.
1. Section title changes.
2. Moving the glog discussion into installation.rst
3. Re-working the faqs into two separate chapters.

Change-Id: I95dd25bace50f0f9077ef114504999190686963e
2016-11-27 15:12:11 -08:00
Niels Ole Salscheider 2ad14b7a61 make_docs: Pass the file encoding to open()
Otherwise, it will fail on Python 3 with:
"UnicodeDecodeError: 'ascii' codec can't decode byte 0xc2 in position
7690: ordinal not in range(128)"

We have to use io.open() instead of open(), because open() does not
accept the encoding on Python 2.

Change-Id: I77b6552491e8de01d79a26d2f146ddbd968cce49
2016-03-02 22:09:24 +01:00
Mark Moll 1c3d85b0ba Python3 fixes
Change-Id: I5ba9d264cce7b9a986b28fb24f27200d5c5f328d
2015-04-10 22:28:06 -05:00
Keir Mierle 7492b0d8de Update copyright headers with new year and URL
Since Ceres is moving to using GitHub for issues, and the Google
Code URL in the current copyright header will soon become invalid,
update all the headers.

Change-Id: I1fce70375d1bcf098591f07b4d8f01a5c1e0789c
2015-03-18 05:43:23 +00:00
Keir Mierle 38787f44f4 Strip breadcrumb from the documentation frontpage
Change-Id: I14a50de47e304a61b2b6bf3a9cf7cc168286ab40
2014-05-23 00:37:22 +00:00
Keir Mierle 556027a1a0 Strip breadcrumbs from the documentation
Change-Id: I2a1469844e5a20eecdd735f38d68e571fce3f3fa
2014-05-22 23:35:46 +00:00
Pablo Speciale c51b11c104 Sphinx and CMake, based on this example:
http://ericscottbarr.com/blog/2012/03/sphinx-and-cmake-beautiful-documentation-for-c-projects/

The 'docs/CMakeLists.txt' file was deleted in this commit: 0abfb8f46f

Thanks to Arnaud Gelas, he has passed some links:
   https://github.com/InsightSoftwareConsortium/ITKExamples/blob/master/CMake/FindSphinx.cmake
   https://github.com/InsightSoftwareConsortium/ITKExamples/blob/master/CMakeLists.txt#L120-L154

Change-Id: Ic65e7f8ec5280d1e71a897a144417a21761c5553
2013-03-19 21:05:31 +00:00
Sameer Agarwal 931c309b27 Cleanup based on comments by William Rucklidge
Change-Id: If269ba8e388965a8ea32260fd6f17a133a19ab9b
2013-02-25 10:13:29 -08:00
Sameer Agarwal beb4505311 Minor fixes
Based on William Rucklidge's review, including
a nasty bug in parameter block removal.

Change-Id: I3a692e589f600ff560ecae9fa85bb0b76063d403
2013-02-22 13:37:05 -08:00
Sameer Agarwal fa21df8cd9 Add script for building documentation.
Update make_release

Minor documentation fixes.

Change-Id: I1248ec3f58be66b5929aee6f2aa392c15d53ed83
2013-02-18 09:22:08 -08:00