[petsc-dev] building sphinx doc only

[Jacob Faibussowitsch]

> I am trying to figure out why the doc page for PetscOptionsHeadBegin https://petsc.org/release/manualpages/Sys/PetscOptionsHeadBegin/ is broken.

It's missing a Synopsis: section. See PetscOptionsEnd docstring.

> I do 
> 
> cd $PETSC_DIR/doc
> make sphinxhtml
> 
> which takes ages and seems to also build the old style html documentation. Is this right?

I think you can just do 

$ cd ${PETSC_DIR}
$ make docs

This has the added benefit of doing it all in a venv so you don’t pollute your regular python install.

Best regards,

Jacob Faibussowitsch
(Jacob Fai - booss - oh - vitch)

> On Jun 15, 2023, at 11:24, Blaise Bourdin <bourdin at mcmaster.ca> wrote:
> 
> Hi,
> 
> I am trying to figure out why the doc page for PetscOptionsHeadBegin https://petsc.org/release/manualpages/Sys/PetscOptionsHeadBegin/ is broken.
> Following the instructions at https://petsc.org/release/developers/documentation/#developing-petsc-documentation 
> I do 
> 
> cd $PETSC_DIR/doc
> make sphinxhtml
> 
> which takes ages and seems to also build the old style html documentation. Is this right?
> 
> Regards,
> Blaise
> 
> — 
> Canada Research Chair in Mathematical and Computational Aspects of Solid Mechanics (Tier 1)
> Professor, Department of Mathematics & Statistics
> Hamilton Hall room 409A, McMaster University
> 1280 Main Street West, Hamilton, Ontario L8S 4K1, Canada 
> https://www.math.mcmaster.ca/bourdin | +1 (905) 525 9140 ext. 27243
>