Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite the "Build system" documentation page #5049

Merged
merged 10 commits into from
Jan 4, 2025

Conversation

rgommers
Copy link
Contributor

@rgommers rgommers commented Jan 4, 2025

Closes gh-2929

Rendered version of the diagram for ease of reviewing (it does change as needed with light/dark themes too):

image

@rgommers rgommers changed the title Docs buildsystem page Rewrite the "Build system" documentation page Jan 4, 2025
@rgommers
Copy link
Contributor Author

rgommers commented Jan 4, 2025

Doc deployment job failed - will fix that tonight.

This only fixes Markdown syntax, and adds a few headers to bring
some structure into the long list of variables that influence the
build. It does not add or remove variables.
The doc build is now clean of warnings again.
Uses Mermaid to render it as a diagram in the html docs.
Content is reviewed fairly carefully, and should be up to the
same standard as the rest of the docs now.
@rgommers rgommers force-pushed the docs-buildsystem-page branch from 4e219be to f697cfe Compare January 4, 2025 20:19
@martin-frbg martin-frbg added this to the 0.3.29 milestone Jan 4, 2025
@martin-frbg martin-frbg merged commit 74be676 into OpenMathLib:develop Jan 4, 2025
81 of 84 checks passed
@rgommers rgommers deleted the docs-buildsystem-page branch January 5, 2025 00:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation] Help understanding the build system - adding to wiki
2 participants