Skip to content
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.

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

"ocamldoc ... -text README" raises exception #5690

vicuna opened this issue Jul 17, 2012 · 1 comment

"ocamldoc ... -text README" raises exception #5690

vicuna opened this issue Jul 17, 2012 · 1 comment


Copy link

@vicuna vicuna commented Jul 17, 2012

Original bug ID: 5690
Reporter: rmikhov
Assigned to: @zoggy
Status: closed (set by @zoggy on 2012-08-16T09:49:01Z)
Resolution: fixed
Priority: low
Severity: trivial
Version: 3.12.1
Fixed in version: 4.00.1+dev
Category: ocamldoc

Bug description

Ocamldoc has the useful feature to be able to include a text file in the generated documentation, but unfortunately this text file must have an extension.

"ocamldoc ... -text README" raises Invalid_argument("Filename.chop_extension"). The problem is that coding standards often require to name your file README so you have to rename it, run ocamldoc, and rename it back... Also, it would be nice if it didn't show up in the list of modules.

Sorry to bother you.

Copy link

@vicuna vicuna commented Aug 16, 2012

Comment author: @zoggy

Handling -text files with no extension is now possible (Revision 12862 in version/4.00 and revision 12863 in trunk).

They will still appear in the module list, though, to benefit from cross referencing possibilities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet

No branches or pull requests

1 participant