Merge pull request #1004 from CEED/jeremy/doc-fix

Doc fixes

doc - add CeedErrorType to doc

Merge pull request #703 from CEED/jed/doc-myst-nb

doc: replace recommonmark with MyST

doc: skip CeedPragmaOptimizeOn/Off at Doxygen level

Sphinx does not understand the push/pop model, and this leads to
warnings. It's an idiosyncrasy that I don't think needs to be part of
the Sphinx

doc: skip CeedPragmaOptimizeOn/Off at Doxygen level

Sphinx does not understand the push/pop model, and this leads to
warnings. It's an idiosyncrasy that I don't think needs to be part of
the Sphinx site.

show more ...

doc: handle CeedPragmaOptimizeOn/Off

Merge branch 'jed/ceed-version' [PR #698]

* jed/ceed-version:
Add version macros and CeedGetVersion() [fix #697]

Add version macros and CeedGetVersion() [fix #697]

Requested-by: Freddie Witherden <freddie@witherden.org>

Merge pull request #485 from CEED/valeria/jupyter-notebook-tutorials

Some jupyter-notebook tutorials

User manual: Introductory sentences for each API class

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 ...

Merge pull request #446 from CEED/user-manual

Sphinx user manual published at libceed.readthedocs.io

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 ...