Ticket #9654 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Doc building fails if VATES algorithms present and VATES is not built

Reported by: Nick Draper Owned by: Martyn Gigg
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester: Vickie Lynch

Description

LoadVTK has some documentation, but crashes out doc test if make_vates is not selected.

The branch contains a LoadVTK-v1.rst file to this should be obvious on running the build of the docs.

Change History

comment:1 Changed 6 years ago by Nick Draper

re #9654 rst file added that causes crash is not Make_VATES

Changeset: 4f3b77ba29238e393faa85ae14ab86d9e4dab399

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

branch is feature/9654_VATES_doc_crash

comment:3 Changed 6 years ago by Martyn Gigg

  • Status changed from assigned to inprogress

Introduce base class for algorithm directives

This will allow for common code to be inserted in the new single run method Refs #9654

Changeset: 852e4737ea613cb34a0b47cbc630e5eb8dcae0ee

comment:4 Changed 6 years ago by Martyn Gigg

Skip sphinx directive if algorithm is currently unknown.

Spits out a warning on the output page and in the build to indicate that the directive was skipped. This is required to make development builds that don't have all libraries built easier to work with. Refs #9654

Changeset: 9ef036dc5e4443b00d17dd95fbb751de044753cc

comment:5 Changed 6 years ago by Martyn Gigg

  • Status changed from inprogress to verify
  • Resolution set to fixed

branch: feature/9654_VATES_doc_crash

tester: Merge the code and build the documentation without having the documentation built. Look at the built page for LoadVTK in docs/qthelp/algorithms/LoadVTK-v1.html. There should be error messages and no algorithm headers sections but the build should have completed.

comment:6 Changed 6 years ago by Martyn Gigg

  • Priority changed from minor to critical

comment:7 Changed 6 years ago by Vickie Lynch

  • Status changed from verify to verifying
  • Tester set to Vickie Lynch

comment:8 Changed 6 years ago by Vickie Lynch

  • Status changed from verifying to closed

Merge remote branch 'origin/feature/9654_VATES_doc_crash'

Full changeset: ​cd4c7e632ce3e7ffbf9f215372c4c79dd40b9d27

comment:9 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10497

Note: See TracTickets for help on using tickets.