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

Add doc generation infra #2

Open
wokalski opened this issue Mar 27, 2022 · 0 comments
Open

Add doc generation infra #2

wokalski opened this issue Mar 27, 2022 · 0 comments
Labels
good first issue Good for newcomers

Comments

@wokalski
Copy link
Contributor

wokalski commented Mar 27, 2022

We don't have good docs. There's a Makefile with a doc generation script which is a good start. To automatically deploy them to https://dialohq.github.io/ocaml-grpc/ we need to run the doc generation script (preferably in a GitHub action) and then put the result from _build/default/_doc/_html to /docs on the main branch and commit them using the GitHub action user.

It should be as simple as a GitHub workflow like this:

name: Publish docs
on:
  push:
    branches:
      - main 
jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Generate docs 
        run: |
          # Run opam install(s)
          make docs
      - name: Commit report
        run: |
          # run only if anything has changed!
          # if $(git diff --quiet) returns a non zero result
          git add docs
          git commit -m "Update docs"
          git push

I wouldn't advise contributors to run the doc generation scripts during development and committing changes because it might introduce some additional conflicts for the generated code that we really don't care about.


To make the docs nicer we should add a .mld index page

@wokalski wokalski added the good first issue Good for newcomers label Mar 27, 2022
mbacarella pushed a commit to mbacarella/ocaml-grpc that referenced this issue May 7, 2022
Async unary and streaming clients
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant