Skip to content

Commit

Permalink
[doc] Mention .document file in README (#1153)
Browse files Browse the repository at this point in the history
* Mention `.document` file in README

Rdoc has `.document` file in its root directory, allowing us to
determine which files are the target for documentation.
However, this fact is not mentioned anywhere in the doc including
README, which makes it quite difficult to utilize this feature.
This commit adds a mention to `.document` file in README so that
users can find the feature more easily.

One thing I'm not sure is if it's the right place.
Currently README includes some usage information, which can be a
separate file.
  • Loading branch information
okuramasafumi committed Aug 12, 2024
1 parent ac6f8ac commit d711a2c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ To generate documentation programmatically:
rdoc.document options
# see RDoc::RDoc

You can specify the target files for document generation with +.document+ file in the project root directory.
+.document+ file contains a list of file and directory names including comment lines starting with '#'.
See https://github.com/ruby/rdoc/blob/master/.document as an example.

== Writing Documentation

To write documentation for RDoc place a comment above the class, module,
Expand Down

0 comments on commit d711a2c

Please sign in to comment.