search

openhwgroup / core-v-xif

RISC-V eXtension interface that provides a generalized framework suitable to implement custom coprocessors and ISA extensions
https://docs.openhwgroup.org/projects/openhw-group-core-v-xif/en
Other
53 stars 23 forks source link

[TASK] Enable RTD build on release/tag #220

Open christian-herber-nxp opened 2 months ago

christian-herber-nxp commented 2 months ago

Is there an existing CV-X-IF task for this?

Task Description

Currently, adding a new release (which includes a tag), does not cause this to show up on read the docs. This should happen automatically.

Description of Done

github releases cause the tag to be added to readthedocs builds

DBees commented 2 months ago

Gathering Observations to see what's going on (1) Checked that the Github release latest version https://github.com/openhwgroup/core-v-xif/releases - you have v1.0.0-rc.2

(2) RTD Project home "Versions" https://readthedocs.com/projects/openhw-group-core-v-xif/versions/ "Versions" was not listing rc.2 explicitly, but "latest" correctly pointed to rc.2

I have now enabled "activate version" for rc.2, it is now listed as one of the versions available, and latest still pointing to rc.2

(3) RTD Project home "Download" https://readthedocs.com/projects/openhw-group-core-v-xif/downloads/

It had no mention of rc.2 The Latest PDF document actually shows Release v1.0.0-rc.3-dev.1 on the version page

After "activate version" for rc.2, rc.2 is now listed as one of the versions available. However, clicking rc.2 PDF https://docs.openhwgroup.org/_/downloads/openhw-group-core-v-xif/en/v1.0.0-rc.2/pdf/ still leads you to a PDF showing Release v1.0.0-rc.3-dev.1 on the version page