Re: [petsc-dev] User(s) manual sections field in manual pages?

2019-06-17 Thread Jed Brown via petsc-dev
Patrick Sanan writes: >> It ought, I suppose, be possible to write a plugin that adds links >> automagically to all keywords in formatted source, but I don't know the >> details of how these are written. >> > Sounds like Jed's suggesting that this could be done with a script similar > to the one

Re: [petsc-dev] User(s) manual sections field in manual pages?

2019-06-17 Thread Jed Brown via petsc-dev
Lawrence Mitchell writes: >> On 17 Jun 2019, at 19:50, Jed Brown via petsc-dev >> wrote: > > [...] >> >> As for strategy, we have these primary forms of documentation: >> >> * Users Manual >> >> A lot of value here is in cross-references between the manual and man >> pages. PETSc has a

Re: [petsc-dev] User(s) manual sections field in manual pages?

2019-06-17 Thread Lawrence Mitchell via petsc-dev
> On 17 Jun 2019, at 19:50, Jed Brown via petsc-dev > wrote: [...] > > As for strategy, we have these primary forms of documentation: > > * Users Manual > > A lot of value here is in cross-references between the manual and man > pages. PETSc has a special pass where it creates links

Re: [petsc-dev] User(s) manual sections field in manual pages?

2019-06-17 Thread Jed Brown via petsc-dev
Patrick Sanan writes: > What are the options for incrementalism with this general approach? Does it > make much sense to say "let's make sure the manual is online first, and > then later we can update the man pages and tutorials?". Note: The above "incrementalism" is different from my previous