Fix broken PDF format link and create UpdatedIndexforPDF.md #3856
Conversation
This file contains 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
- Fixed broken PDF link in index.md.
- Created UpdatedIndexforPDF.md to serve as a clean version for PDF
generation, avoiding HTML syntax issues present in the original
index.md.
- Addressed numerous broken links in index.md, which necessitated the
creation of UpdatedIndexforPDF.md to ensure the PDF documentation
routes correctly.
- Enhanced the new UpdatedIndexforPDF.md to include underlines for
text with attached links, improving usability.
- Plan to submit a separate pull request to fix all broken links
in the original index.md.
|
Hi @Akshit222, the files in https://github.com/jump-dev/JuMP.jl/tree/master/docs/src are the input to the documentation build, not the output. The documentation website gets built by running the script: https://github.com/jump-dev/JuMP.jl/blob/master/docs/make.jl in this CI job: https://github.com/jump-dev/JuMP.jl/blob/master/.github/workflows/documentation.yml You can view the official documentation at https://jump.dev/JuMP.jl/stable/ You'll notice that the links etc all work correctly (including in the PDF, which is automatically built in CI). If you have ideas for how we can improve the documentation please comment in #2348 and we can also chat about why things are the way they currently are. Closing this PR as won't-fix. |
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.
This pull request addresses several issues in the documentation related to PDF generation.
-Fixed broken PDF link in index.md.
-Created UpdatedIndexforPDF.md to serve as a clean version for PDF generation, avoiding HTML syntax issues present in the
original index.md.
-Addressed numerous broken links in index.md, which necessitated the creation of UpdatedIndexforPDF.md to ensure the PDF
documentation routes correctly.
-Enhanced the new UpdatedIndexforPDF.md to include underlines for text with attached links, improving usability.
-Plan to submit a separate pull request to fix all broken links in the original index.md.
-As this is my first pull request, I appreciate any feedback or suggestions for improvement.