Skip to content

[DOC] Omit include files from html #307

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.

Sign up for GitHub

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

Merged
kou merged 4 commits into from
Dec 19, 2025
+11 −10
Merged

[DOC] Omit include files from html #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
65f2698
[DOC] Omit include files from html
BurdetteLamar Dec 8, 2025
54ad82a
[DOC] Fix links to tasks
BurdetteLamar Dec 8, 2025
10be7af
[DOC] Rename task toc file
BurdetteLamar Dec 18, 2025
4df26a4
[DOC] Fix links to tasks toc
BurdetteLamar Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/rexml/tasks/includes/.document
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Don't make html for these include files.
0 doc/rexml/tasks/tocs/child_toc.rdoc → doc/rexml/tasks/includes/child_toc.rdoc
View file
Open in desktop
File renamed without changes.
0 doc/rexml/tasks/tocs/document_toc.rdoc → doc/rexml/tasks/includes/document_toc.rdoc
View file
Open in desktop
File renamed without changes.
0 doc/rexml/tasks/tocs/element_toc.rdoc → doc/rexml/tasks/includes/element_toc.rdoc
View file
Open in desktop
File renamed without changes.
0 doc/rexml/tasks/tocs/node_toc.rdoc → doc/rexml/tasks/includes/node_toc.rdoc
View file
Open in desktop
File renamed without changes.
0 doc/rexml/tasks/tocs/parent_toc.rdoc → doc/rexml/tasks/includes/parent_toc.rdoc
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion doc/rexml/tasks/rdoc/child.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Class Child includes module Node;
see {Tasks for Node}[node_rdoc.html].

:include: ../tocs/child_toc.rdoc
:include: ../includes/child_toc.rdoc

=== Relationships

Expand Down
2 changes: 1 addition & 1 deletion doc/rexml/tasks/rdoc/document.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ see:
- {Tasks for Node}[node_rdoc.html].
- {Module Enumerable}[https://docs.ruby-lang.org/en/master/Enumerable.html].

:include: ../tocs/document_toc.rdoc
:include: ../includes/document_toc.rdoc

=== New Document

Expand Down
2 changes: 1 addition & 1 deletion doc/rexml/tasks/rdoc/element.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ see:
- {Tasks for Node}[node_rdoc.html].
- {Module Enumerable}[https://docs.ruby-lang.org/en/master/Enumerable.html].

:include: ../tocs/element_toc.rdoc
:include: ../includes/element_toc.rdoc

=== New Element

Expand Down
2 changes: 1 addition & 1 deletion doc/rexml/tasks/rdoc/node.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
== Module Node

:include: ../tocs/node_toc.rdoc
:include: ../includes/node_toc.rdoc

=== Siblings

Expand Down
2 changes: 1 addition & 1 deletion doc/rexml/tasks/rdoc/parent.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ see:
- {Tasks for Node}[node_rdoc.html].
- {Module Enumerable}[https://docs.ruby-lang.org/en/master/Enumerable.html].

:include: ../tocs/parent_toc.rdoc
:include: ../includes/parent_toc.rdoc

=== Queries

Expand Down
0 doc/rexml/tasks/tocs/master_toc.rdoc → doc/rexml/tasks/rdoc/toc.rdoc
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions lib/rexml/document.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ module REXML
# If you're somewhat familiar with XML
# 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/toc_rdoc.html],
# and in particular, the
# {tasks page for documents}[../doc/rexml/tasks/tocs/document_toc_rdoc.html].
# {tasks for documents}[../doc/rexml/tasks/rdoc/toc_rdoc.html#label-Document].
#
class Document < Element
# A convenient default XML declaration. Use:
Expand Down
4 changes: 2 additions & 2 deletions lib/rexml/element.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ module REXML
# If you're somewhat familiar with XML
# 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/toc_rdoc.html],
# and in particular, the
# {tasks page for elements}[../doc/rexml/tasks/tocs/element_toc_rdoc.html].
# {tasks for elements}[../doc/rexml/tasks/rdoc/toc_rdoc.html#label-Element].
#
# === Name
#
Expand Down
2 changes: 1 addition & 1 deletion lib/rexml/rexml.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#
# If you're somewhat familiar with XML
# and have a particular task in mind,
# you may want to see {the tasks pages}[doc/rexml/tasks/tocs/master_toc_rdoc.html].
# you may want to see {the tasks pages}[doc/rexml/tasks/rdoc/toc_rdoc.html].
#
# == API
#
Expand Down
Loading