[Merged by Bors] - doc: update README.md instructions for building documentation locally#18713
Closed
[Merged by Bors] - doc: update README.md instructions for building documentation locally#18713
Conversation
PR summary 7c06df6362Import changes for modified filesNo significant changes to the import graph Import changes for all files
Declarations diffNo declarations were harmed in the making of this PR! 🐙 You can run this locally as follows## summary with just the declaration names:
./scripts/declarations_diff.sh <optional_commit>
## more verbose report:
./scripts/declarations_diff.sh long <optional_commit>The doc-module for |
grunweg
reviewed
Nov 25, 2024
Contributor
grunweg
left a comment
There was a problem hiding this comment.
Looks good, but I haven't tested this locally. This appears to match the zulip thread, though. Can somebody else please confirm these instructions?
maintainer merge?
|
🚀 Pull request has been placed on the maintainer queue by grunweg. |
Member
Author
The mathlib4_docs Github Action sets its |
mathlib-bors bot
pushed a commit
that referenced
this pull request
Nov 28, 2024
…#18713) Since #14229, the current instructions in README.md for building docs no longer work. This PR updates the instructions to refer to the `mathlib4_docs` repo, which is discussed in [this zulip thread](https://leanprover.zulipchat.com/#narrow/channel/287929-mathlib4/topic/How.20does.20build.20.26.20deploy.20document.20for.20Mathlib4.20currently.3F/near/476591680).
Contributor
|
Pull request successfully merged into master. Build succeeded: |
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
3 participants
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.
Since #14229, the current instructions in README.md for building docs no longer work.
This PR updates the instructions to refer to the
mathlib4_docsrepo, which is discussed inthis zulip thread.