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

docs: Fix gRPC API generation for online docs #27014

Merged
merged 1 commit into from
Jul 26, 2023

Commits on Jul 24, 2023

  1. docs: Symlink (instead of copying) the API reference

    To generate the gRPC API reference, we copy the "api" repository at the
    root of the repository to "Documentation/_api". This step is required
    everywhere we need to build the docs:
    
      - Locally, we run it through the "copy-api" target in
        Documentation/Makefile, before generating the HTML.
      - Same thing for the Netlify preview, where "copy-api" is a dependency
        for the "html-netlify" target.
      - However, on ReadTheDocs, where we generate and host the online
        documentation, we do not perform this step; nor do we use the
        Makefile at all.
    
    As a workaround, let's simplify the way we access the API reference.
    Instead of copying the docs, just symlink them from the Documentation
    directory.
    
    Signed-off-by: Quentin Monnet <quentin@isovalent.com>
    qmonnet committed Jul 24, 2023
    Configuration menu
    Copy the full SHA
    9070f8e View commit details
    Browse the repository at this point in the history