| #
c5a41aec
|
| 30-Apr-2025 |
Jeremy L Thompson <jeremy@jeremylt.org> |
ci - use newer images for docs build (#1816)
* ci - use newer images for docs build
* doc - explicitly install playwright first
|
| #
05b44d1b
|
| 21-Feb-2023 |
Jed Brown <jed@jedbrown.org> |
Merge pull request #1162 from CEED/jed/doc-update-packages
doc: update packages
|
| #
c990f896
|
| 21-Feb-2023 |
Jed Brown <jed@jedbrown.org> |
ReadTheDocs: update environment
Old LuaLaTeX in the default environment is causing us problems
|
| #
d22f9ef9
|
| 08-Apr-2020 |
Jed Brown <jed@jedbrown.org> |
Merge pull request #510 from CEED/jed/sphinx-3.0
doc: upgrade to sphinx-3.0
|
| #
9c6151e5
|
| 08-Apr-2020 |
Jed Brown <jed@jedbrown.org> |
doc: disable epub because it does not render math
|
| #
5a6e2571
|
| 08-Apr-2020 |
Jed Brown <jed@jedbrown.org> |
doc: use python3.8
|
| #
f6d735e9
|
| 06-Apr-2020 |
Valeria Barra <39932030+valeriabarra@users.noreply.github.com> |
Small doc fixes (#499)
* A small shift in notation
* Docs: Clarify ex2-surface mathematical description
* Refactor \boldsymbol -> \bm
* Refactor \mathbf -> \bm
* Sphinx: clear html_stati
Small doc fixes (#499)
* A small shift in notation
* Docs: Clarify ex2-surface mathematical description
* Refactor \boldsymbol -> \bm
* Refactor \mathbf -> \bm
* Sphinx: clear html_static_path
This is needed to avoid the 'html_static_path entry '_static' does not exist' warning
https://github.com/readthedocs/readthedocs.org/issues/1776
* Fix some incosistencies
* Invert inner products (u,v) -> (v,u)
* Add SVG figure for coordinates on the sphere
* doc: use dirhtml on readthedocs
* Improve caption of sphere coords figure
* Add reference to figure in the bps on the cubed-sphere section
Co-authored-by: Jed Brown <jed@jedbrown.org>
show more ...
|
| #
da62e0a9
|
| 08-Mar-2020 |
Jed Brown <jed@jedbrown.org> |
Merge pull request #446 from CEED/user-manual
Sphinx user manual published at libceed.readthedocs.io
|
| #
4c4400c7
|
| 08-Mar-2020 |
Valeria Barra <valeriabarra21@gmail.com> |
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 ...
|