User manual and jupyter-notebook: a bit of rewording

User manual: Introductory sentences for each API class

Convert README.md -> README.rst and include README parts in gettingstarted.rst

doc: update instructions for Python

User manual: Small wording changes

User manual: Add Gallery of QFunctions and small consistency improvements

User manual: style

Add VLA support for CUDA backends (#481)

* CUDA - add VLA support for CUDA backends

* Navier-Stokes - guard #include math.h for CUDA

* Navier-Stokes - fix struct definitions for code generatio

Add VLA support for CUDA backends (#481)

* CUDA - add VLA support for CUDA backends

* Navier-Stokes - guard #include math.h for CUDA

* Navier-Stokes - fix struct definitions for code generation

* Navier-Stokes - fix file location of mass QFunction

* Navier-Stokes - minor style consistency

* Navier-Stokes - more context sturct fixing

* Navier-Stokes - cast context to stop CUDA errors

* Navier-Stokes - change helper functions to inline to silence CUDA errors

* CUDA - clean up CEED_Q_VLA definition for cuda/gen

* Navier-Stokes - populate TODOs for undocumenced functions

* Doc - document libCEED macros

* CUDA - use -default-device for NVRTC

* Tests - add t507 to test VLA support

* CUDA - fix my bug in dim, Q1d for cuda/gen

* Tests - update tap/junit to reflect current CUDA capabilities

* make style

* CUDA - check output bases for dim, Q1d as well (this fixes multigrid example support)

* CUDA - fix readSliceQuads, not all arguments were defined

* Navier-Stokes - document all functions in Navier-Stokes QFunction files

* make style

show more ...

doc: note about double and single dot contraction added to FEMtheory

doc: switch from mathjax to katex

NS: stabilization added to doc

Thanks-to: Valeria Barra <valeriabarra21@gmail.com>

Add citation and bib info

Homogenize all section headers style to 40 chars

Use consistent section headers style

This is not only for consistency sake, but it also allows for easy visualization of section breaks

doc: use latest Sphinx (2.4.4) instead of legacy RTD default

doc: minor reorganization

* Rename Implementation to Interface Concepts
* Move Theoretical Framework into Interface Concepts
* Drop top-level toctree depth from 5 to 4

doc: split examples into separate files in the source tree

* Copy examples/**.rst into the source directory so they can be picked
up by Sphinx.
* Some minor corrections/clarifications to docs that

doc: split examples into separate files in the source tree

* Copy examples/**.rst into the source directory so they can be picked
up by Sphinx.
* Some minor corrections/clarifications to docs that I noticed while
splitting them apart (shame on me for bundling in this commit).

show more ...

doc: process restrict qualifier as predefined

Breathe and/or Sphinx lacks support for restrict qualifiers, so use
the workaround suggested here to hide the restrict qualifier from
Breathe/Sphinx.

h

doc: process restrict qualifier as predefined

Breathe and/or Sphinx lacks support for restrict qualifiers, so use
the workaround suggested here to hide the restrict qualifier from
Breathe/Sphinx.

https://github.com/michaeljones/breathe/issues/477#issuecomment-593145041

An alternative is to use the C domain for *.c and *.h files. This
handles restrict, but reduces enum names to their numeric value. Once
that Breathe/Sphinx bug is fixed, we could skip the restrict elision
in favor of using the C domain.

show more ...

doc: convert to Sphinx documentation at libceed.readthedocs.io

Some technical notes about the expanded docs/process:

* Doxygen is now restricted to API documentation. Sphinx docs are
incomplete

doc: convert to Sphinx documentation at libceed.readthedocs.io

Some technical notes about the expanded docs/process:

* Doxygen is now restricted to API documentation. Sphinx docs are
incomplete surrogates due to not hyperlinking code listings, though
we hope the Doxygen site can be removed eventually.

* PDF output uses XeTeX (unicode and OTF fonts) with TeX Gyre Pagella
and DejaVu Sans Mono. You may need to install these fonts in order
to build the PDF users manual.

* Obtaining the author list from Git has not worked on
ReadTheDocs (`git shortlog` is empty even though `git log` is not),
so we automatically generate it on developer machines with `make
doc`. If the author information is incorrect/mangled, edit .mailmap
to fix the mapping.

* Math semantics are based on the description here
https://github.com/sphinx-doc/sphinx/issues/3785

Sphinx chooses one of two setups for the maths.

* If there is a single equation, then we wrap the maths in
\begin{equation*} (or equation).

* If there are multiple equations (as determined by the presence of
an empty line), then we wrap the maths first in \begin{aligned}
and then in \begin{align*} (or align).

Co-authored-by: Jeremy L. Thompson <jeremy.thompson@colorado.edu>
Co-authored-by: Jed Brown <jed@jedbrown.org>

show more ...