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 'jolivet/feature-less-checkfalse' into 'main'

Dividing by four the number of PetscCheckFalse()

See merge request petsc/petsc!5072

Remove some PetscCheckFalse()

Merge branch 'jacobf/2022-03-26/variadic-chkerrq-stragglers' into 'main'

Clean Up Variadic-CHKERRQ Stragglers

See merge request petsc/petsc!5033

fixup some remaining stragglers from !4889

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

rename PetscAssert() -> PetscCheck() and PetscAssertDebug() -> PetscAssert()

add PetscAssert() and PetscAssertFalse()

make PetscInfo() variadic

SETERRQ[1-9]+ begone

Merge remote-tracking branch 'origin/jose/fix-manpages'

Fix manpages to avoid errors reported by doctext

See merge request petsc/petsc!4309

Fix manpages: Input/Output Parameter --> Parameters

Merge branch 'barry/2021-04-06/fix-bad-error-code-returns' into 'main'

Fix bad error code returns in various places in PETSc

See merge request petsc/petsc!3846

Fix code that did not pass appropriate PETSc error flags to SETERRQ()

Add checkbadSource check for use of SETERRQ() without an appropriate error flag

Commit-type: error-checking, bug-fix, testing-f

Fix code that did not pass appropriate PETSc error flags to SETERRQ()

Add checkbadSource check for use of SETERRQ() without an appropriate error flag

Commit-type: error-checking, bug-fix, testing-fix, style-fix
/spend 2.5h

show more ...

Merge branch 'barry/2020-08-16/fix-source-formatting' into 'master'

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

See merge request petsc/petsc

Merge branch 'barry/2020-08-16/fix-source-formatting' into 'master'

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

See merge request petsc/petsc!3064

show more ...

Turn on checkbadSource test to generate an error when found; fix all source code that causes errors

Commit-type: portability-fix, testing-fix, style-fix, feature, maintainability
/spend 1.5h

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

Merged in barry/update-collective-on (pull request #1744)

Update the use of Collective on in the manual pages to reflect the new style

Update the use of Collective on in the manual pages to reflect the new style

Commit-type: style-fix, documentation
Thanks-to: Patrick Sanan <patrick.sanan@gmail.com>

Merge branch 'master' into jpusztay/feature-swarm-symplectic-example