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 -css-style doesn't seem to work. #4430

Closed
vicuna opened this issue Oct 24, 2007 · 8 comments
Closed

ocamldoc -css-style doesn't seem to work. #4430

vicuna opened this issue Oct 24, 2007 · 8 comments

Comments

@vicuna
Copy link

vicuna commented Oct 24, 2007

Original bug ID: 4430
Reporter: @dbuenzli
Assigned to: @zoggy
Status: confirmed (set by @damiendoligez on 2012-07-11T14:04:25Z)
Resolution: reopened
Priority: normal
Severity: feature
Version: 3.10.0
Category: ocamldoc

Bug description

ocamldoc when invoked with -css-style doesn't generate any css file.

@vicuna
Copy link
Author

vicuna commented Oct 24, 2007

Comment author: @dbuenzli

Sorry, replace ocamlbuild by ocamldoc.

[ed: done]

@vicuna
Copy link
Author

vicuna commented Oct 24, 2007

Comment author: @zoggy

This option does not generate a css file, but is used to indicate the url of the style sheet to reference in the html files generated by ocamldoc. A css file is generated in the output directory, called style.css. This file is always generated, except if it already exists.

@vicuna
Copy link
Author

vicuna commented Oct 24, 2007

Comment author: @dbuenzli

Hello Maxence,

Sorry, I didn't understand. But then I suggest you clarify the documentation since it says :

-css-style filename
Use filename as the Cascading Style Sheet file.

So I thought filename would be used to generate style.css. Maybe :

-css-style uri
Use uri as the Cascading Style Sheet file of generated files.

However I think something as I understood is needed because the current behaviour of not generating a file only if style.css is already present in the directory does not play nicely with ocamlbuild which generates everything in a directory that can be safely erased. Thus if you want to use a custom style file you need to copy your style.css after generation in the documentation directory (i.e. understand too much of the underdocumented ocamlbuild). An easy way of having a custom style while using ocamlbuild .odocl would be nice. But I don't know if it is a matter of changing ocamlbuild or ocamldoc.

Best,

Daniel

P.S.
Just to clarify, you say a style.css is always generated unless it already exists, to which I add or if -css-style is not used.

@vicuna
Copy link
Author

vicuna commented Oct 24, 2007

Comment author: @dbuenzli

In my preceding message not used -> used.

@vicuna
Copy link
Author

vicuna commented Jul 11, 2012

Comment author: @damiendoligez

Fix the documentation, then reclassify this as a feature wish.

@vicuna
Copy link
Author

vicuna commented Sep 25, 2012

Comment author: @zoggy

Documentation fixed in revision 12955.

@dbuenzli
Copy link
Contributor

This can be closed.

@vicuna
Copy link
Author

vicuna commented Mar 15, 2019

Thanks!

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

No branches or pull requests

2 participants