Skip to content
Merged
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
3 changes: 2 additions & 1 deletion doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ sphinx >=4.0.0
sphinx-fortran
sphinx_rtd_theme
sphinxcontrib.bibtex
sphinx-copybutton
sphinx-copybutton
sphinx-toolbox
333 changes: 333 additions & 0 deletions doc/shared/FAQ.rst

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/shared/History.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
SUNDIALS Copyright End
----------------------------------------------------------------

.. _History:
.. _ReleaseHistory:

###############
Release History
Expand Down
12 changes: 12 additions & 0 deletions doc/shared/sundials/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1785,6 +1785,18 @@ the first example and ``libsundials_cvode``, ``libsundials_nveccuda``,
Refer to the documentations sections for the individual packages and modules of
SUNDIALS that interest you for the proper includes and libraries to link to.

Furthermore, each of the sundials solvers is distributed with a set of examples demonstrating basic
usage. To build and install the examples, set both ``EXAMPLES_ENABLE_<lang>`` and
:cmakeop:`EXAMPLES_INSTALL` to ``ON`` and specify the example installation directory
:cmakeop:`EXAMPLES_INSTALL_PATH`. CMake will generate a ``CMakeLists.txt`` configuration file (and
``Makefile`` files if on Linux/Unix) that reference the installed sundials headers and libraries. Either
the ``CMakeLists.txt`` file or the traditional ``Makefile`` may be used to build the examples as well as
serve as a template for creating user developed solutions. To use the supplied ``Makefile`` simply run
``make`` to compile and generate the executables. To use CMake, from within the installed example
directory, run ``cmake`` (or ``ccmake`` to use the GUI) followed by make to compile the example code. Note
that if CMake is used, it will overwrite the traditional ``Makefile`` with a new CMake generated
``Makefile``.


Using SUNDIALS as a Third Party Library in other CMake Projects
---------------------------------------------------------------
Expand Down
13 changes: 13 additions & 0 deletions doc/superbuild/source/FAQ_link.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. ----------------------------------------------------------------
SUNDIALS Copyright Start
Copyright (c) 2002-2024, Lawrence Livermore National Security
and Southern Methodist University.
All rights reserved.

See the top-level LICENSE and NOTICE files for details.

SPDX-License-Identifier: BSD-3-Clause
SUNDIALS Copyright End
----------------------------------------------------------------

.. include:: ../../shared/FAQ.rst
3 changes: 2 additions & 1 deletion doc/superbuild/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx_rtd_theme', 'sphinx.ext.ifconfig', 'sphinx.ext.mathjax',
'sphinxfortran.fortran_domain', 'sphinxcontrib.bibtex',
'sphinx_copybutton', 'sphinx.ext.graphviz', 'sphinx_sundials']
'sphinx_copybutton', 'sphinx.ext.graphviz', 'sphinx_sundials',
'sphinx_toolbox.collapse']

# References
bibtex_bibfiles = ['../../shared/sundials.bib']
Expand Down
1 change: 1 addition & 0 deletions doc/superbuild/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ SUNDIALS License and Notices
sunmemory/index.rst
History_link.rst
Changelog_link.rst
FAQ_link.rst

.. toctree::
:caption: DEVELOPMENT
Expand Down
Loading