Fix missing entries/formatting in some manual pages

Commit-type: docs
/spend 10m

Merge branch 'psanan/docs-sphinx-man-pages' into 'main'

Integrate Man Pages into Sphinx Docs

Closes #1132 and #1015

See merge request petsc/petsc!4989

Docs: bulk add backticks to .seealso man page fields

```python
import os
import re
import fileinput

def _process_word(word):
comma = "," if word.endswith(",") else ""
return "`%s`%s" % (wor

Docs: bulk add backticks to .seealso man page fields

```python
import os
import re
import fileinput

def _process_word(word):
comma = "," if word.endswith(",") else ""
return "`%s`%s" % (word.rstrip(","), comma)

def _process_stripped_line(line):
return " ".join(map(_process_word, line.split()))

start_pattern = re.compile(r"^( *\.seealso:? )(.*$)")

def process_file(filename_full):
with fileinput.FileInput(filename_full, inplace=True) as f:
in_block = False
for line in f:
line_stripped = line.strip()
# end ".seealso blocks" on a blank line or C-style comment close
line_modified = None
if not line_stripped:
in_block = False
elif line_stripped.endswith("*/"):
in_block = False
else:
match = re.match(start_pattern,
line) # not stripped line
if match:
indent = " " * len(match.group(1))
in_block = True
line_modified = match.group(
1) + _process_stripped_line(
match.group(2).strip())
elif in_block:
line_modified = indent + _process_stripped_line(
line_stripped)
if line_modified:
print(line_modified) # prints to the file
else:
print(line, end="") # prints to the file

BASE_DIRS = ["src", "include"]
EXT = [".c", ".cxx", ".cpp", ".cu", ".h", ".hpp", ".hxx"]
EXCLUDE_DIRS = ["tests", "tutorials", "ftn-auto", "ftn-custom", "benchmarks"]

def main():
""" Process everything """
for base in BASE_DIRS:
for root, dirs, files in os.walk(base):
for filename in files:
if os.path.splitext(filename)[1] in EXT:
filename_full = os.path.join(root, filename)
print("FILE ---", filename_full)
process_file(filename_full)
for exclude_dir in EXCLUDE_DIRS:
if exclude_dir in dirs:
dirs.remove(exclude_dir)

if __name__ == "__main__":
main()
```

show more ...

Merge branch 'jacobf/2022-02-23/variadic-chkerr' into 'main'

Variadic CHKERRQ()

See merge request petsc/petsc!4889

The great renaming:

- CHKERRQ() -> PetscCall()
- CHKERRV() -> PetscCallVoid()
- CHKERRMPI() -> PetscCallMPI()
- CHKERRABORT() -> PetscCallAbort()
- CHKERRCONTINUE() -> PetscCallContinue()
- CHKERRXX

The great renaming:

- CHKERRQ() -> PetscCall()
- CHKERRV() -> PetscCallVoid()
- CHKERRMPI() -> PetscCallMPI()
- CHKERRABORT() -> PetscCallAbort()
- CHKERRCONTINUE() -> PetscCallContinue()
- CHKERRXX() -> PetscCallThrow()
- CHKERRCXX() -> PetscCallCXX()
- CHKERRCUDA() -> PetscCallCUDA()
- CHKERRCUBLAS() -> PetscCallCUBLAS()
- CHKERRCUSPARSE() -> PetscCallCUSPARSE()
- CHKERRCUSOLVER() -> PetscCallCUSOLVER()
- CHKERRCUFFT() -> PetscCallCUFFT()
- CHKERRCURAND() -> PetscCallCURAND()
- CHKERRHIP() -> PetscCallHIP()
- CHKERRHIPBLAS() -> PetscCallHIPBLAS()
- CHKERRHIPSOLVER() -> PetscCallHIPSOLVER()
- CHKERRQ_CEED() -> PetscCallCEED()
- CHKERR_FORTRAN_VOID_FUNCTION() -> PetscCallFortranVoidFunction()
- CHKERRMKL() -> PetscCallMKL()
- CHKERRMMG() -> PetscCallMMG()
- CHKERRMMG_NONSTANDARD() -> PetscCallMMG_NONSTANDARD()
- CHKERRCGNS() -> PetscCallCGNS()
- CHKERRPTSCOTCH() -> PetscCallPTSCOTCH()
- CHKERRSTR() -> PetscCallSTR()
- CHKERRTC() -> PetscCallTC()

show more ...

chkerr and friends wrapped

Merge branch 'jacobf/2022-01-05/c99' into 'main'

Feature: C99 and C++11

See merge request petsc/petsc!4700

add PetscDesignatedInitializer() and apply it PetscRandom_*, AO_*, Vec_Seq, and Vec_MPI

Merge branch 'jacobf/2021-05-13/promote-petscrandom-headers' into 'main'

move petscrandom headers to include/petsc/private

See merge request petsc/petsc!3971

move petscrandom headers to include/petsc/private

Merge branch 'stefanozampini/feature-vecrandom-minmax-device' into 'master'

Support VecSetRandom and VecMin/Max for VECCUDA

See merge request petsc/petsc!3578

PetscRandom: add CURAND support

Merge branch 'dalcinl/fix-null' into 'master'

Sys: Replace 0 -> NULL for pointers

See merge request petsc/petsc!2482

Sys: Replace 0 -> NULL for pointers

Merge commit 'd47bf9aaf1e5266cc3f0ff499f934c85788965a9' into jed/fix-matcreatempibaij/maint

Obtain changed (v3.5) handling of MatMPIBAIJSetPreallocationCSR to match
documentation.

Merge branch 'master' into knepley/feature-plex-sphere-mesh

* master: (2633 commits)
Bib: Added ref
SNES ex56: Update test output
add a citation to petsc.bib
Plex: Initialize variables
ini

Merge branch 'master' into knepley/feature-plex-sphere-mesh

* master: (2633 commits)
Bib: Added ref
SNES ex56: Update test output
add a citation to petsc.bib
Plex: Initialize variables
initialize ap as complained by the nightly tests
Plex ex3: Update to new point function API
initialize some variables as complained by nightly tests
SNES ex12: Mix misnaming Nf --> Nc
update tests
add tests
add MatView_SeqXAIJ_ASCII_structonly(); enable A->structure_only in MatSetValuesBlocked_SeqBAIJ
typo
fill-in some references
Bib: Fixed ref
Plex: Added PLY to file support
Plex: Adding PLY support
PetscDS: Turn off Fortran bindings for Constants
Plex tests: Updated to new point function API
SNES ex56: Moved tests to new format
DM: Allow field projection functions to take an array of scalars - This will allow us to pass in user data to kernels without void *, more efficiency than aux fields
...

Conflicts:
config/builder.py
include/petscdmplex.h
src/dm/impls/plex/examples/tests/ex1.c
src/dm/impls/plex/plexcreate.c
src/dm/impls/plex/plexgmsh.c
src/snes/examples/tutorials/ex63.c

show more ...

Merge branch 'master' into knepley/feature-plex-pragmatic-parallel

* master: (1379 commits)
Minor fixes for tchem examples due to changes in PETSc infrastructure
update webpage about API changes

Merge branch 'master' into knepley/feature-plex-pragmatic-parallel

* master: (1379 commits)
Minor fixes for tchem examples due to changes in PETSc infrastructure
update webpage about API changes
add help menu for MatCreateSubMatricesMPI()
rename struct Mat_SubMat -> Mat_SubSppt
add a little information to the manual about using tchem
rename MatCreateSubMatrixComposite -> MatCreateSubMatrixVirtual; Mat_SubMatrix -> Mat_SubVirtual
need to protect the \ passed on the makefile on my Mac
Bib: Updated ref
update src/mat/examples/tests/output/ex23_#.out
rename MatGetSubMat -> MatCreateSubMat
Mark MatCreateMPIAIJWithSplitArrays() and MatMPIAIJSetPreallocationCSR() with MAT_NO_OFF_PROC_ENTRIES
superlu: libray is installed in PREFIX/lib64 - fix this to use PREFIX/lib
backport fixes cc105cc3 2b35c90a - required for 3bf428d - that was backported from master - 80c96bb
'echo -n' fails on opensolaris/osx - so avoid using it.
fix diffs in nightlybuilds due to options in ~/.petscrc
add Kelley03 to src/docs/tex/petsc.bib
build: determine moudles, mpi.h used during buildtime and print in 'info'
fix analyzer warnings
fix build failure on opensolaris - where -lm from flibs is removed due to -lm in cxxlibs. But then - only flib gets used for some configure tests [blaslapack, parms]
config: prefer __restrict over C99 restrict keyword
...

show more ...

Merge branch 'barry/remove-funct'

Remove the use and definition of __FUNCT__ throughout the code

Since all modern C/C++ compilers provide this functionality we no longer need to provide it manually in PETSc
Time: 1.5 hours
Thanks-t

Remove the use and definition of __FUNCT__ throughout the code

Since all modern C/C++ compilers provide this functionality we no longer need to provide it manually in PETSc
Time: 1.5 hours
Thanks-to: Andreas Mang <andreas@ices.utexas.edu>

show more ...

Merge branch 'master' into jed/ts-eimex

Sync to include Git conversion, PETSC_EXTERN, and minor API changes.

Conflicts:
src/ts/interface/tsregall.c

Automerge.

Hg-commit: b6659d546870fb013f3da5bcd5066d1dc0dc329c

Merge branch 'master' of gitifyhg::ssh://hg@bitbucket.org/BarryFSmith/petsc-dev-simp

Symbol visibility and namespacing.

C++ builds always set extern "C" and can be called from plain C. Most
users w

Merge branch 'master' of gitifyhg::ssh://hg@bitbucket.org/BarryFSmith/petsc-dev-simp

Symbol visibility and namespacing.

C++ builds always set extern "C" and can be called from plain C. Most
users will only want --with-clanguage=C++ for std::complex.


Hg-commit: f848d02318cae92d7b32037c7ee88f92dbe46347

show more ...

Change all PETSC_EXTERN_C to PETSC_EXTERN

Hg-commit: 8d2ebbb193fb583bccc64015e35640c4e08c3426

Change all PETSC_EXTERN_C to PETSC_EXTERN


Hg-commit: ba0cf153561ff2dc521f42e94b7164fbe7b5d798

updated from EXTERN_C_BEGIN/END through sys directory

Hg-commit: ee6b7ef2f48ce66402e7e807302de19506ce15df