Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render programmers' manual in docs #469

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.

Loading