Ticket #9559 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Sphinx script not working on windows

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

Description (last modified by Martyn Gigg) (diff)

The docs/runsphinx.py script doesn't work on windows because the it can't find the bundled Sphinx distribution using the pkg_resources.

Change History

comment:1 Changed 6 years ago by Martyn Gigg

  • Status changed from new to assigned
  • Description modified (diff)

comment:2 Changed 6 years ago by Martyn Gigg

  • Status changed from assigned to inprogress

Add search path for CMake to find Sphinx on Windows.

Refs #9559

Changeset: 893e11b45c29368910ec476ec713101d153850b7

comment:3 Changed 6 years ago by Martyn Gigg

Simplify Sphinx runner script.

It just calls the sphinx.main() function directly without the need to go through pkg_resources. Refs #9559

Changeset: 8fac852114a841ed1ccff506a7292aacae3b7b6c

comment:4 Changed 6 years ago by Martyn Gigg

Group the documentation targets in Visual Studio.

Refs #9559

Changeset: 95be1d53d7b983934194b4cbed996281b1d12509

comment:5 Changed 6 years ago by Martyn Gigg

Use .summary() instead of deprecated .getWikiSummary()

Refs #9559

Changeset: b9c991e774490d73f4f5af9dad8d2a8c3625e09c

comment:6 Changed 6 years ago by Martyn Gigg

Ensure MantidPlot exits with 0 status code on script success.

Refs #9559

Changeset: 334175b9ca254322c5405534a590198f07129b40

comment:7 Changed 6 years ago by Martyn Gigg

Correction for CMake folder target.

Refs #9559

Changeset: 315b453bda2fecab8b9333de2eab15f5bc39de1a

comment:8 Changed 6 years ago by Martyn Gigg

Fix case of VS folder name

Refs #9559

Changeset: 538904dc35dda4022f983fda22b5bc613c838d48

comment:9 Changed 6 years ago by Martyn Gigg

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

comment:10 Changed 6 years ago by Martyn Gigg

  • Status changed from verify to reopened
  • Resolution fixed deleted

comment:11 Changed 6 years ago by Martyn Gigg

  • Status changed from reopened to inprogress

Exclude the sphinx docs by default from VS build

Refs #9559

Changeset: c3b0fe09a69528e007f0e6c9601a275ad8ec253c

comment:12 Changed 6 years ago by Martyn Gigg

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

comment:13 Changed 6 years ago by Nick Draper

  • Status changed from verify to closed

Merge remote-tracking branch 'origin/feature/9559_fix_sphinx_on_windows'

Full changeset: ​f130b4a1f57e448e890b8eaf3a074bdfc9060506

comment:14 Changed 6 years ago by Martyn Gigg

Merge branch 'feature/9559_fix_sphinx_on_windows'

Full changeset: ​9dd0d9f431b6ad34cf67534603f9f63b3d7c4630

comment:15 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10402

Note: See TracTickets for help on using tickets.