search

jongough / ocpn_draw_pi

OpenCPN general drawing plug in
8 stars 18 forks source link

Add manual for testing Antora #465

Closed oplaydo closed 3 years ago

oplaydo commented 3 years ago

Jon...

When Rick has accepted a new PR for the manual you will see a file has been added - build.yml. You can see it in my PR.

This file allows Antora (if installed) to build the HTML docs, as will be included in the manual docs folder.

Just an example and editing still need for the Watchdog manual.

oplaydo commented 3 years ago

Have you found any way of stopping CI building when PR are made for changes to the manual. Do I need a GitHub workflow file and use 'Actions'?

rgleason commented 3 years ago

Mike Look at Jon's or my circleci/config.yml You can make deployment false and you can make each build false arrived at after much trial and error also Jon will correct this but you can add [skip travis] and skip [appveyor] as a part of the commit.

jongough commented 3 years ago

Could you please ensure you have upgraded to the latest master and base your changes off of that. This will make the process easier as the 'builds' should work. You have based these changes on master_1.6 which is an old master which allowed changes to the 1.6 base of OD. We are now working on the 1.8 base (master).

To avoid building appveyor and circleci just add [skip ci] [skip appveyor] to your commit message on the first line.

Thanks

jongough commented 3 years ago

I have now added the files to the repository using your pull as a base but creating my own for the current master. I also used the [skip ..] command to avoid the builds.