Ticket #9611 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Bundle documentation in package

Reported by: Martyn Gigg Owned by: Martyn Gigg
Priority: blocker Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #9629 Tester: Peter Peterson

Description

Also hook up the help buttons to point a browser at the bundled help rather than using the QtAssistant.

Change History

comment:1 Changed 6 years ago by Martyn Gigg

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Martyn Gigg

  • Status changed from assigned to inprogress

Package up the html help

Use the same location that the QtAssistant helpused to go. Refs #9611

Changeset: 3b3ea947063f6c3eefa9b52c758cce89231d68ac

comment:3 Changed 6 years ago by Martyn Gigg

Switch from qtassistant to web browser ...

pointing at a local copy of the documentation. Refs #9611

Changeset: da2d54c09a9aa1b7eaa0793c442fceb1ad54bd14

comment:4 Changed 6 years ago by Martyn Gigg

Remove qtassistant and wiki tools

No longer required now that the documentation is in the rst files. Refs #9611

Changeset: 120057f64a3e76b1c02df48b97c3110ccef49c88

comment:5 Changed 6 years ago by Martyn Gigg

Fix broken category links.

Refs #9611

Changeset: 0fa630a755de0f81a03a99dd731f16e9bd0c0bbd

comment:6 Changed 6 years ago by Martyn Gigg

Use cmake variable to control packaging of offline documentation

It's not built by all platforms on incremental builds so it needs to be turned off in these situations. Refs #9611

Changeset: 85901216466c11a5f5b8cba5bf7e1654ae03a79e

comment:7 Changed 6 years ago by Martyn Gigg

Move the html package target inside the check for Sphinx.

Refs #9611

Changeset: b8f6a4253547e731d65fbbb4b5444c2dad971747

comment:8 Changed 6 years ago by Martyn Gigg

Ignore windows html build errors.

Refs #9611

Changeset: b8be1a95ec044d8a782108f3c3e526d931edab22

comment:9 Changed 6 years ago by Martyn Gigg

Fix MantidPlot path on the Mac

Refs #9611

Changeset: 23d73c383ecaef05d2ecbff51005673718fd4b26

comment:10 Changed 6 years ago by Martyn Gigg

Allow for configuration directory on Mac builds too.

Xcode has a similar layout to VS. Refs #9611

Changeset: 5cdb0413bc81629cadb9f439d53a80840087fce9

comment:11 Changed 6 years ago by Martyn Gigg

Workaround so that Mac builds can find the properties file.

Refs #9611

Changeset: f1864d5178ee81dd4ee5b0cd6929d066e0b68b1e

comment:12 Changed 6 years ago by Martyn Gigg

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

Branch: feature/9611_package_html_help

Tester: Build the docs-html target - this will build the framework and MantidPlot. Start MantidPlot verify that the help links go to the expected places. Things to watch out for:

  • Algorithm box question mark button
  • Links in the help menu

You should also check that this works with a package. Look here, http://builds.mantidproject.org/job/develop_clean/, and click on the appropriate platform to get the latest package build from develop. Install it and check the same as above.

comment:13 Changed 6 years ago by Peter Peterson

  • Status changed from verify to verifying
  • Tester set to Peter Peterson

comment:14 Changed 6 years ago by Peter Peterson

  • Blocking 9629 added

comment:15 Changed 6 years ago by Martyn Gigg

Package up the html help

Use the same location that the QtAssistant helpused to go. Refs #9611

Changeset: e3cec913b01f60d1063fedaff3631541cdc52965

comment:16 Changed 6 years ago by Martyn Gigg

Switch from qtassistant to web browser ...

pointing at a local copy of the documentation. Refs #9611

Changeset: c409a19a80dbd97e17238102b92bc913a4107ac7

comment:17 Changed 6 years ago by Martyn Gigg

Remove qtassistant and wiki tools

No longer required now that the documentation is in the rst files. Refs #9611

Changeset: 5a92e72719b48c97d38e3e015d18f8e10733669a

comment:18 Changed 6 years ago by Martyn Gigg

Fix broken category links.

Refs #9611

Changeset: 0b674f2013a0eab6eb578eb908946142395c0d34

comment:19 Changed 6 years ago by Martyn Gigg

Use cmake variable to control packaging of offline documentation

It's not built by all platforms on incremental builds so it needs to be turned off in these situations. Refs #9611

Changeset: dc22e60690ef437d39d36a73c63928842014cc5d

comment:20 Changed 6 years ago by Martyn Gigg

Move the html package target inside the check for Sphinx.

Refs #9611

Changeset: 3a7456476fae5bf27df2f01f9e0608c7ef09e6b2

comment:21 Changed 6 years ago by Martyn Gigg

Ignore windows html build errors.

Refs #9611

Changeset: b85a3dcd36775afdccf70c2533aa2d0dc9908016

comment:22 Changed 6 years ago by Martyn Gigg

Fix MantidPlot path on the Mac

Refs #9611

Changeset: af9c861b00c5cc20c6f8cd1bb2ebb9cc9013b493

comment:23 Changed 6 years ago by Martyn Gigg

Allow for configuration directory on Mac builds too.

Xcode has a similar layout to VS. Refs #9611

Changeset: 5324edd70123ef24d1df76815e4fc18a911892f5

comment:24 Changed 6 years ago by Martyn Gigg

Workaround so that Mac builds can find the properties file.

Refs #9611

Changeset: f4ab56f4509f440e2a40c37e875893cb02677bf1

comment:25 Changed 6 years ago by Pete Peterson

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9611_package_html_help'

Full changeset: ee390e111ff43c1aa6377590496e954f766b7bbd

comment:26 Changed 6 years ago by Peter Peterson

There is an issue on the mac (#9629) that needs to be dealt with.

comment:27 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10454

Note: See TracTickets for help on using tickets.