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

coqdoc #24

Closed
aa755 opened this issue May 13, 2016 · 5 comments
Closed

coqdoc #24

aa755 opened this issue May 13, 2016 · 5 comments

Comments

@aa755
Copy link
Contributor

aa755 commented May 13, 2016

Is there some website that publicly hosts the coqdoc (html) for coq-ext-lib?

@gmalecha
Copy link
Collaborator

Currently no. You wouldn't happen to have a script that builds it in a suitable way to publish as a github pages would you?

@aa755
Copy link
Contributor Author

aa755 commented May 13, 2016

I use CoRN/math-classes' scons scripts to build coqdoc (and .vo files as well). Those scripts find out all the .v files, including those in the non-std-lib dependencies, and invoke coqdoc on the entire collection at once -- this is necessary for cross-linking between files and libraries.
Because coq-ext-lib does not use have any non-std-lib dependencies, you can build coqdoc using
coqdoc -utf8 --toc --interpolate --no-lib-name --coqlib http://coq.inria.fr/library -d coqdoc -R theories Extlib [all_v_files]

If you wish to use scons scripts to automate the instantiation of [all_v_files], let me know and I will be happy to submit a pull request.
If github-pages enforces some restrictions on the hosted .html files, additional work may be needed.

@gmalecha
Copy link
Collaborator

A pull request would be great.

@aa755
Copy link
Contributor Author

aa755 commented May 13, 2016

I noticed that the Makefile generated by Coq already supports coqdoc generation:
make -f Makefile.coq html

@gmalecha
Copy link
Collaborator

Temporary documentation can now be found here http://coq-ext-lib.github.io/coq-ext-lib/

I need to see if there is some way to set up something to auto-generate documentation.

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

2 participants