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

building ocsigen documentation and building doc from .eliom files #595

Open
MdeLv opened this issue May 24, 2020 · 1 comment
Open

building ocsigen documentation and building doc from .eliom files #595

MdeLv opened this issue May 24, 2020 · 1 comment

Comments

@MdeLv
Copy link
Contributor

MdeLv commented May 24, 2020

Following #594 and ocsigen/graffiti#11, can you tell us:

1/ how to build eliom documentation from its source with eliomdoc?
And for ocsigenserver, js_of_ocaml, tyxml as well?

2/ how to build the documentation of a program from its .eliom[i] and .ml[i] files?
man eliomc references http://ocsigen.org/eliom/manual/workflow-compilation which is a broken link (btw, this needs to be fixed).
However, this link is available: https://ocsigen.org/eliom/6.6/manual/workflow-compilation#h5o-5 .

I could preprocess a few .eliom files
$ eliompp -server foo.eliom

However, the following outputs nothing:

$ eliompp -client foo.eliom
# 1 "foo.eliom"
# 1 "<command-line>"
# 1 "foo.eliom"

while there are some let%client and let%shared definitions in foo.eliom .
It's not normal because there are client definitions and because shared definitions are supposed to be duplicated as server and client declarations.
How to fix that?

I could not use
$ eliomdoc -client -d doc/client -html foobar.eliom Fatal error: exception Fl_package_base.No_such_package("js_of_ocaml-camlp4", "required by eliom.syntax.predef'")
I tried the following commands with no success:
$ eliomdoc -pp eliompp -client -d doc/client -html foobar.eliom
$ eliomdoc -pp eliompp -package js_of_ocaml-camlp4 -client -d doc/client -html foobar.eliom $ eliomdoc -ppx eliompp -client -d doc/client -html foobar.eliom`
...
Where is js_of_ocaml-camlp4 or remplacement available? (ppx?)
How to do?

Thanks

@MdeLv
Copy link
Contributor Author

MdeLv commented Mar 22, 2023

Is there still someone in the eliom team ??

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

No branches or pull requests

1 participant