Merge branch 'barry/2022-12-02/copyedit-last-part-manual/release' into 'release'

Copyediting and cleanup of later sections of user manual; add links to manual...

See merge request petsc/petsc!5902

Copyediting and cleanup of later sections of user manual; add links to manual from PetscLog and PetscView manual pages

Commit-type: documentation
/spend 8h

Merge remote-tracking branch 'origin/release'

Merge branch 'jed/doc-sphinx-design' into 'release'

doc: switch to sphinx-design from deprecated sphinx-panels

See merge request petsc/petsc!5812

doc: switch to sphinx-design from deprecated sphinx-panels

This repository is not actively maintained. Use sphinx-design instead!
See the migration guide and this github issue for more informati

doc: switch to sphinx-design from deprecated sphinx-panels

This repository is not actively maintained. Use sphinx-design instead!
See the migration guide and this github issue for more information.
https://github.com/executablebooks/sphinx-panels

show more ...

Merge remote-tracking branch 'origin/release'

Merge branch 'balay/doc-fix' into 'release'

doc: fix warning with pydata-sphinx-theme-0.12.0: page_sidebar_items -> secondary_sidebar_items

See merge request petsc/petsc!5849

docs: pydata-sphinx-theme-0.12.0 gives:

looking for now-outdated files... WARNING: The configuration `page_sidebar_items` is deprecated.Use `secondary_sidebar_items`.

prior version: pydata-sphinx-t

docs: pydata-sphinx-theme-0.12.0 gives:

looking for now-outdated files... WARNING: The configuration `page_sidebar_items` is deprecated.Use `secondary_sidebar_items`.

prior version: pydata-sphinx-theme-0.11.0

show more ...

Merge remote-tracking branch 'origin/release'

Merge branch 'barry/2022-10-06/doc-doc-generation/release' into 'release'

fixes for webpages

See merge request petsc/petsc!5724

Remove changes files from toc so they do not get listed in all manual pages

Saves 100 megabytes of memory

Improve the documentation generation tools with clearer comments on what they do

Commit-type: docs-only

Merge branch 'psanan/docs-man-page-index-columns' into 'main'

Docs: use multiple columns for man pages index pages

See merge request petsc/petsc!5224

Docs: Remove "on this page" from right sidebar

This prevents it from getting in the way of overflowing
content in the main column.

This is a kludge and I don't personally like it. It removes
a stan

Docs: Remove "on this page" from right sidebar

This prevents it from getting in the way of overflowing
content in the main column.

This is a kludge and I don't personally like it. It removes
a standard feature of the theme which people might expect,
and it compromises all pages for the sake a of a couple which
have their own hack.

show more ...

Merge branch 'tisaac/docs-dark-theme-logo' into 'main'

Add logo with white text for dark theme to sphinx conf

See merge request petsc/petsc!5428

Add logo with white text for dark theme to sphinx conf

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: fix "Edit this page" links for man pages

This relies on the brittle approach of adding another post-processing
pass to the HTML man pages.

This does not fix the links on man page section inde

Docs: fix "Edit this page" links for man pages

This relies on the brittle approach of adding another post-processing
pass to the HTML man pages.

This does not fix the links on man page section index pages.

show more ...

Docs: add manual page redirects

For the dirhtml docs buld, add a script to add HTML files for all
previous man page locations, e.g.

docs/manualpages/Foo/Bar.html

linking to the new dirhtml loca

Docs: add manual page redirects

For the dirhtml docs buld, add a script to add HTML files for all
previous man page locations, e.g.

docs/manualpages/Foo/Bar.html

linking to the new dirhtml locations, e.g

docs/manualpages/Foo/Bar/index.html

show more ...

Docs: reorganize conf.py classic docs logic to only execute for HTML builds

Docs: refactor classic docs build into pre and post to allow proper mapping

The URLs required to link to the new, integrated manual pages now
depend on the Sphinx builder (dirhtml or html), as in th

Docs: refactor classic docs build into pre and post to allow proper mapping

The URLs required to link to the new, integrated manual pages now
depend on the Sphinx builder (dirhtml or html), as in the new
htmlmap_modified. To allow this same mapping file to be used with
C2HTML when the HTML source pages are built (with the classic process),
refactor to delay this stage until after the main Sphinx build
and to use htmlmap_modified.

show more ...

Docs: add Sphinx extension to allow skipping some large toc trees for man pages

This is intended to speed up the Sphinx build.

Docs: update htmlmap links in place, based on builder type

Generate an htmlmap_modified file (in the classic docs tree) with modified manpage links
based on the location of generated HTML files from

Docs: update htmlmap links in place, based on builder type

Generate an htmlmap_modified file (in the classic docs tree) with modified manpage links
based on the location of generated HTML files from the Sphinx
html or dirhtml builder.

show more ...

Docs: Generate MyST (.md) files instead of .html for man pages

Use a new version of Sowing doctext that accepts the -myst flag.

We use a mostly-duplicated local myst.def here.

Split the copying of

Docs: Generate MyST (.md) files instead of .html for man pages

Use a new version of Sowing doctext that accepts the -myst flag.

We use a mostly-duplicated local myst.def here.

Split the copying of the classic docs into a "pre" and "post" stage,
now accepting a destination argument, so that .md manualpage files
may be copied at the start of the Sphinx build.

Change -html to -myst in the manualpages target.

Remove the manualpages_buildcite target entirely, as we
remove the -mapref argument from the manualpages target.
Now the .cit file is generated during a single run of doctext and
converted to htmlmap, which is used to create man pages links with the
custom Sphinx extension.

Remove the add_version_header.py script, which leaves a few classic
HTML pages without a version, but this feature was mainly for the man
pages, which now have the same version information at the bottom as
all the Sphinx-generated pages.

This commit does not address further required changes:
- index.html pages auto-generated in the docs/manualpages/ tree have not been converted to .md
- Man page postprocessing stages have not been updated to operate on .md instead of .html and will thus fail

show more ...

Docs: add MyST (Markdown) parser extension

Ignore the images directory, as it does not contain Sphinx source files,
and README.md images there are otherwise interpreted as such.