Doc migration#491
Draft
Becheler wants to merge 46 commits into
Draft
Conversation
|
An automated preview of the documentation is available at https://491.graph.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-05-19 15:18:38 UTC |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrate Boost.Graph documentation to Antora
NOTE: There is no way to split this PR properly, as all
.htmlfiles need to be replaced all at once.NOTE: The ~40000 lines of change in doc source code don't need direct review. Instead please review the preview currently hosted on the fork's Github Pages: https://becheler.github.io/graph/graph/index.html
This PR switches Boost.Graph from the pre-baked BoostBook/Quickbook HTML at
doc/*.htmlto an Antora source tree underdoc/modules/ROOT/. Once merged, the next Boost release will publish the new site atwww.boost.org/doc/libs/<version>/libs/graph/automatically (release-tools auto-detectsdoc/build_antora.sh).Changes
doc/modules/ROOT/with 209.adocpages and 154 paired.cpp/.txtexample sidecars.doc/build_antora.sh,doc/package.json(antora 3.1.14 + lunr extension), anddoc/package-lock.jsonfor reproducible installs.doc/*.html/doc/*.htm, superseded by the Antora pages.doc/figs/(106 files) anddoc/stoer_wagner_imgs/(15 files); the new doc carries its own copies underdoc/modules/ROOT/assets/images/.read_graphml.rst,read_graphviz.rst,write_graphml.rst), replaced bydoc/modules/ROOT/pages/io/{graphml,graphviz}.adoc.doc/Makefile(LaTeX/pdflatex/dvips rules from 2002, no longer used by any toolchain in the repo).Verification
cd doc && ./build_antora.sh playbook.ymlsucceeds end-to-end and producesdoc/build/site/graph/index.html.Known follow-ups (not blocking this PR)
.adocdocumentation once this PR ships.git diff --exit-codeon.txtafter rebuild), may be best to defer until the random-generator examples are RNG-seeded so the diff is deterministic. Also maybe over-engineered.graphinboostorg/website-v2-docs'libs.playbook.ymlfor switching @Becheler fork Github Pages preview to continuous preview atantora.cppalliance.org.