Skip to content

Commit

Permalink
Render programmers' manual in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robertodr authored and ilfreddy committed Jan 23, 2024
1 parent a1c6199 commit c37e8f6
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 29 deletions.
14 changes: 0 additions & 14 deletions doc/programmers/general-structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,6 @@ General Structure

External libraries:

+ parts of the C++ `Boost <http://www.boost.org/>`_ libraries are used to provide
various functionality, like timing and metaprogramming.
The source for the 1.54.0 release is shipped with the
module's source code. Some of the libraries used
need to be compiled. Boost is released under the terms
of the `Boost Software License, v1.0 <http://opensource.org/licenses/BSL-1.0>`_ (see also
http://www.boost.org/users/license.html) We encourage the use of
Boost whenever some functionality has already been coded within those
libraries. However, consider **carefully** the introduction of functionality
depending on compiler Boost libraries.
+ the `Eigen <http://eigen.tuxfamily.org/index.php?title=Main_Page>`_ template
library for linear algebra. Almost every operation involving matrices and
vectors is performed through Eigen. Eigen provides convenient type
Expand All @@ -23,10 +13,6 @@ External libraries:
at the `getting started guide <http://eigen.tuxfamily.org/dox/GettingStarted.html>`_ to get started.
Eigen is distributed under the terms of the `Mozilla Public License, v2.0
<http://opensource.org/licenses/MPL-2.0>`_
+ the `Getkw library <https://github.com/juselius/libgetkw>`_ by Jonas Juselius is
used to manage input. It is distributed under the terms of the `GNU General
Public License, v2.0 <http://opensource.org/licenses/GPL-2.0>`_
under the terms of the `MIT License <(http://opensource.org/licenses/MIT>`_.
+ the `XCFun library <https://xcfun.address.here/missing>`_ by Ulf
Ekström under the terms of the `GNU General
Public License, v2.0 <http://opensource.org/licenses/GPL-2.0>`_
Expand Down
12 changes: 12 additions & 0 deletions doc/programmers/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@
Programmer's Manual
===================

Coding and maintenance guidelines
---------------------------------

.. toctree::

general-structure
coding-standards
documentation
cmake-usage
maintenance
testing


Classes and functions reference
-------------------------------
Expand Down
15 changes: 0 additions & 15 deletions doc/programmers/programmers-manual.rst

This file was deleted.

0 comments on commit c37e8f6

Please sign in to comment.