Skip to content

[docs] only build and deploy master #1898

Open
@ydcjeff

Description

@ydcjeff

📚 Documentation

We are currently building the docs from all tags / releases using master template and configs. And there are a bunch of warnings for past releases. This can lead to docs building error if we are going to bump sphinx or use BC breaking new features from sphinx. So, we should only build and deploy from master and a tag for a release. Since we only build for master, we can enable -W option which treats warnings as an error and thus docs build will fail, making sure the deployed docs is free of warnings.

Question is how to manage versioned docs ?
We could setup docs build like domain repositories but we'll see if there are any other options

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions