mirror of
https://gitlab.com/libeigen/eigen.git
synced 2026-04-10 11:34:33 +08:00
Big changes in Eigen documentation:
- Organize the documentation into "chapters". - Each chapter include many documentation pages, reference pages organized as modules, and a quick reference page. - The "Chapters" tree is created using the defgroup/ingroup mechanism, even for the documentation pages (i.e., .dox files for which I added an \eigenManualPage macro that we can switch between \page or \defgroup ). - Add a "General topics" entry for all pages that do not fit well in the previous "chapters". - The highlevel struture is managed by a new eigendoxy_layout.xml file. - remove the "index" and quite useless pages (namespace list, class hierarchy, member list, file list, etc.) - add the javascript search-engine. - add the "treeview" panel. - remove \tableofcontents (replace them by a custom \eigenAutoToc macro to be able to easily re-enable if needed). - add javascript to automatically generate a TOC from the h1/h2 tags of the current page, and put the TOC in the left side panel. - overload various javascript function generated by doxygen to: - remove the root of the treeview - remove links to section/subsection from the treeview - automatically expand the "Chapters" section - automatically expand the current section - adjust the height of the treeview to take into account the TOC - always use the default .css file, eigendoxy.css now only includes our modifications - use Doxyfile to specify our logo - remove cross references to unsupported modules (temporarily)
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
namespace Eigen {
|
||||
|
||||
o /** \mainpage Eigen
|
||||
/** \mainpage notitle
|
||||
|
||||
<div class="eimainmenu">
|
||||
\ref GettingStarted "Getting started"
|
||||
@@ -29,7 +29,7 @@ For a first contact with Eigen, the best place is to have a look at the \ref Get
|
||||
- \ref TutorialSparse
|
||||
- \ref TutorialMapClass
|
||||
- \ref QuickRefPage
|
||||
- <b>Advanced topics</b>
|
||||
- \subpage UserManual_Generalities
|
||||
- \ref TopicAliasing
|
||||
- \ref TopicLazyEvaluation
|
||||
- \ref TopicLinearAlgebraDecompositions
|
||||
@@ -50,8 +50,6 @@ For a first contact with Eigen, the best place is to have a look at the \ref Get
|
||||
- \ref TopicStructHavingEigenMembers
|
||||
- \ref TopicPassingByValue
|
||||
- \ref TopicWrongStackAlignment
|
||||
|
||||
|
||||
|
||||
Want more? Checkout the \ref Unsupported_modules "unsupported modules" <a href="unsupported/index.html">documentation</a>.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user