Skip to content

Docs: migrate TAO manual to Sphinx

Patrick Sanan requested to merge psanan/docs-tao-manual-migrate into release

This MR takes care of most of the grunt work of moving the TAO manual from LaTeX to Sphinx. The aim is to reproduce the existing content and integrate it into the larger set of PETSc docs. The entire manual is on one web page within the PETSc manual, and this content is also used to generate a single PDF technical report for both PETSc and TAO.

For now the focus is on cleanly moving all existing TAO manual content. How it should be improved should be discussed on other dev channels and/or in future MRs.

If one or more reviewers could at least do a sanity check to make sure I haven't introduced obvious errors, that would be very helpful. In particular, please look carefully at included example code, references to figures/tables/equtaions, and command-line option examples - those are the most likely places that errors could have crept in via pandoc or my manual (ha) cleanups.

To quickly see what it looks like, use the new docs review procedure:

  • make sure the pipeline "pause-for-approval" job has been clicked so that the "docs-review" job has run. One should see green checks, not a black gear, in the pipelines section near the top of the MR.
  • click "view app"
  • Navigate to the page of interest - here, click "Documentation" at the top, then "PETSc and TAO Users Manual", and then "TAO Users Manual".

@sbalay This can probably be squashed when merging

Closes #876 (closed)

Edited by Patrick Sanan

Merge request reports