Skip to content

Commit d711a2c

Browse files
[doc] Mention .document file in README (#1153)
* 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.
1 parent ac6f8ac commit d711a2c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.rdoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@ To generate documentation programmatically:
6060
rdoc.document options
6161
# see RDoc::RDoc
6262

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

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

0 commit comments

Comments
 (0)