1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
.. Copyright (c) 2022 Science and Technology Facilities Council.
All rights reserved.
Modifications made as part of the fparser project are distributed
under the following license:
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Reference Guide
===============
The fparser Reference Guide consists of auto-generated
API documentation produced using both the :ref:`AutoAPI Sphinx plugin <autoapi>`
and :ref:`Doxygen <doxygen>`.
.. _autoapi:
Sphinx and AutoAPI-generated Documentation
------------------------------------------
The Sphinx/AutoAPI documentation is
:doc:`here. <autoapi/index>` or you can use the navigation
pane on the left.
.. _doxygen:
Doxygen-generated Documentation
-------------------------------
.. raw:: html
<p>
If you would prefer to see the Doxgen-generated pages then they are
<a href="_static/html/index.html">here.</a> Since these are generated
separately there are no links back to this Sphinx-generated content - you
will need to use the back button on your browser.
<p>
.. note:: Many of the classes used in the implementation of fparser
are constructed dynamically at runtime. As a result, they will not
appear in the documentation generated by Doxygen.
|
