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

Documentation: Integrate odoc to generate documentation #122

Open
bryphe opened this issue Dec 19, 2018 · 5 comments

Comments

Projects
None yet
4 participants
@bryphe
Copy link
Member

commented Dec 19, 2018

odoc is a great OCaml-community-supported project for generating documentation - and it even integrates with esy. It'd be awesome if we could use it to generate some initial documentation.

I imagine we'll need to do a better job of documenting in the files (using the proper code-block comments to get good descriptions in the documentations) - it'd be helpful to know what we need to do there to get high-quality docs.

@ulrikstrid

This comment has been minimized.

Copy link
Contributor

commented Dec 25, 2018

cc @ostera

@Akin909

This comment has been minimized.

Copy link
Member

commented Jan 20, 2019

@samatar26 (@bryphe, @samatar26 is a friend who is interested in helping out, he's a JS developer, new to reason), this might be a good issue for you to start with if you want to help out, might need to have a look at the docs for odoc and see how to integrate it here then maybe find some comments and change them to the right ones (its in the docs) and see if you can output some docs

@wokalski

This comment has been minimized.

Copy link
Collaborator

commented Jan 20, 2019

We've been also trying to research this for Brisk. It'd be great to use the same infra.

@ulrikstrid

This comment has been minimized.

Copy link
Contributor

commented Jan 21, 2019

Might want to have a look here on how to generate the docs in CI: https://github.com/esy-ocaml/hello-reason/blob/master/.ci/utils/create-docs.yml

@ulrikstrid

This comment has been minimized.

Copy link
Contributor

commented Feb 13, 2019

The infra is actually done in #251, when we land #272 with some actual docs I think this can be closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.