Skip to content

Commit 4cac6bd

Browse files
authored
Render programmers' manual in docs
1 parent e0ea9c9 commit 4cac6bd

File tree

3 files changed

+12
-29
lines changed

3 files changed

+12
-29
lines changed

doc/programmers/general-structure.rst

-14
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,6 @@ General Structure
33

44
External libraries:
55

6-
+ parts of the C++ `Boost <http://www.boost.org/>`_ libraries are used to provide
7-
various functionality, like timing and metaprogramming.
8-
The source for the 1.54.0 release is shipped with the
9-
module's source code. Some of the libraries used
10-
need to be compiled. Boost is released under the terms
11-
of the `Boost Software License, v1.0 <http://opensource.org/licenses/BSL-1.0>`_ (see also
12-
http://www.boost.org/users/license.html) We encourage the use of
13-
Boost whenever some functionality has already been coded within those
14-
libraries. However, consider **carefully** the introduction of functionality
15-
depending on compiler Boost libraries.
166
+ the `Eigen <http://eigen.tuxfamily.org/index.php?title=Main_Page>`_ template
177
library for linear algebra. Almost every operation involving matrices and
188
vectors is performed through Eigen. Eigen provides convenient type
@@ -23,10 +13,6 @@ External libraries:
2313
at the `getting started guide <http://eigen.tuxfamily.org/dox/GettingStarted.html>`_ to get started.
2414
Eigen is distributed under the terms of the `Mozilla Public License, v2.0
2515
<http://opensource.org/licenses/MPL-2.0>`_
26-
+ the `Getkw library <https://github.com/juselius/libgetkw>`_ by Jonas Juselius is
27-
used to manage input. It is distributed under the terms of the `GNU General
28-
Public License, v2.0 <http://opensource.org/licenses/GPL-2.0>`_
29-
under the terms of the `MIT License <(http://opensource.org/licenses/MIT>`_.
3016
+ the `XCFun library <https://xcfun.address.here/missing>`_ by Ulf
3117
Ekström under the terms of the `GNU General
3218
Public License, v2.0 <http://opensource.org/licenses/GPL-2.0>`_

doc/programmers/manual.rst

+12
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22
Programmer's Manual
33
===================
44

5+
Coding and maintenance guidelines
6+
---------------------------------
7+
8+
.. toctree::
9+
10+
general-structure
11+
coding-standards
12+
documentation
13+
cmake-usage
14+
maintenance
15+
testing
16+
517

618
Classes and functions reference
719
-------------------------------

doc/programmers/programmers-manual.rst

-15
This file was deleted.

0 commit comments

Comments
 (0)