Changes in gettingstarted.md

57574c6fad597abceec04b720a8bc12cf23261cb - Merge pull request #1829 from CEED/jeremy/documentation-markers

Thu, 29 May 2025 16:23:13 +0000

Merge pull request #1829 from CEED/jeremy/documentation-markersUse HTML comments as doc inclusion markers List of files: /libCEED/doc/sphinx/source/gettingstarted.md

525f58efad3fdbd516b1ca0b43ee04d6060753fc - doc - use HTML comments as inclusion markers

Thu, 29 May 2025 15:52:49 +0000

doc - use HTML comments as inclusion markers List of files: /libCEED/doc/sphinx/source/gettingstarted.md

d89549c6e0afe634fc6cadb472a2a3224f4b1b63 - doc - hide inclusion markers in md

Wed, 28 May 2025 21:20:11 +0000

doc - hide inclusion markers in md List of files: /libCEED/doc/sphinx/source/gettingstarted.md

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

Fri, 13 Aug 2021 23:35:28 +0000

Merge pull request #703 from CEED/jed/doc-myst-nbdoc: replace recommonmark with MyST List of files: /libCEED/doc/sphinx/source/gettingstarted.md

bcb2dfae4c301ddfdddf58806f08f6e7d17f4ea5 - doc: replace recommonmark with MyST and migrate ReST to MyST

Thu, 04 Feb 2021 05:01:36 +0000

doc: replace recommonmark with MyST and migrate ReST to MySTThis offers more familiar syntax for most writing, as well as natural$\pi$ math (versus :math:`\pi`) and markdown syntax for all ReSTfeatures.The API doc stubs remain in ReST as recommended for autodoc.https://myst-parser.readthedocs.io/en/latest/sphinx/use.html#use-sphinx-ext-autodoc-in-markdown-filesThe change was largely implemented usinghttps://github.com/executablebooks/rst-to-myst/ with some manualfix-ups. Tables (both ReST built-in tables and list-table) remain undereval-rst until they can be manually updated. List of files: /libCEED/doc/sphinx/source/gettingstarted.md

18b2ae98090ea0d92f2169822645484147bf8ea6 - Merge pull request #487 from CEED/jed/python-packaging

Tue, 24 Mar 2020 17:32:59 +0000

Merge pull request #487 from CEED/jed/python-packagingJed/python packaging List of files: /libCEED/doc/sphinx/source/gettingstarted.md

25118b5f4f2ec4a800d461101d711b68900b0d81 - doc: update instructions for Python

Sun, 22 Mar 2020 23:56:00 +0000

doc: update instructions for Python List of files: /libCEED/doc/sphinx/source/gettingstarted.md

da62e0a989e257e069a5e7b687e03d61a99b685b - Merge pull request #446 from CEED/user-manual

Sun, 08 Mar 2020 23:43:35 +0000

Merge pull request #446 from CEED/user-manualSphinx user manual published at libceed.readthedocs.io List of files: /libCEED/doc/sphinx/source/gettingstarted.md

4c4400c783f304914d75f9af2890e7b9d7abe7ca - doc: convert to Sphinx documentation at libceed.readthedocs.io

Sun, 08 Mar 2020 17:01:09 +0000

doc: convert to Sphinx documentation at libceed.readthedocs.ioSome 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 Co-authored-by: Jed Brown List of files: /libCEED/doc/sphinx/source/gettingstarted.md