[DOC] Omit include files from html #307
Merged
+11
−10
Conversation
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
Member
Author
|
Converting to draft; there's more to do here. |
Member
Author
Member
|
What is fixed by this? Could you explain it in the PR description? We don't want to list 
|
Member
Author
Explanation added to PR description. |
Member
|
Could you rename |
Member
Author
Done. |
kou
reviewed
Dec 18, 2025
lib/rexml/document.rb
Outdated
| # and have a particular task in mind, | ||
| # you may want to see the | ||
| # {tasks pages}[../doc/rexml/tasks/tocs/master_toc_rdoc.html], | ||
| # {tasks pages}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html], |
Member
There was a problem hiding this comment.
Should we update this path and other similar paths?
Suggested change
| # {tasks pages}[../doc/rexml/tasks/rdoc/master_toc_rdoc.html], | |
| # {tasks pages}[../doc/rexml/tasks/rdoc/toc_rdoc.html], |
Member
|
Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Five pages listed in the left pane at https://ruby.github.io/rexml/ are in fact intended only as include files, and not as independent pages; these files have links that work fine when the files are included (as I intended), but are broken when rendered as separate html (which was not what I intended).
These pages should not be included in the html. The pages are in directory
doc/:The master_toc is okay, and should be included in the html; other pages link to it.
This PR moves those files to a new directory,
includes/, which is omitted from the html; the remaining files stay in place, but their directory is renamed tordoc/.Also fixes links to tasks from Document and Element class pages.