Ticket #8363 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Python documentation generating is broken

Reported by: Martyn Gigg Owned by: Martyn Gigg
Priority: major Milestone: Release 3.1
Component: Framework Keywords:
Cc: Blocked By:
Blocking: Tester: Michael Reuter

Description (last modified by Martyn Gigg) (diff)

Running "make sphinx-html" produces an error: 

There is a syntax error in your configuration file: EOL while scanning string literal (conf.py, line 64)

This appears to stem from the changes to how the version numbers are computed. The template is still using @MtdVersion_WC_LAST_CHANGED_REV@ rather than @VERSION_PATCH@

Change History

comment:1 Changed 7 years ago by Martyn Gigg

  • Description modified (diff)

comment:2 Changed 7 years ago by Martyn Gigg

  • Status changed from new to inprogress

Fix version numbering in Python sphinx documentation.

Refs #8363

Changeset: 8378efc726a4a6d9f4e00bddab0899b8acf05e86

comment:3 Changed 7 years ago by Martyn Gigg

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

Branch: bugfix/8363_python_docs_config

Tester: This hasn't been run on Windows yet so is best tested Linux. If you don't have sphinx installed then you will need to do an "easy_install Sphinx" before you can proceed.

Once installed type make sphinx-html to build to documentation. It should finish without error and produce output in the sphinx/html subdirectory of the build directory.

comment:4 Changed 7 years ago by Michael Reuter

  • Status changed from verify to verifying
  • Tester set to Michael Reuter

comment:5 Changed 7 years ago by Michael Reuter

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/bugfix/8363_python_docs_config'

Full changeset: ​7e863a05ad8d8f62b5f76eb069f7dde60c8b3c43

comment:6 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​9208

Note: See TracTickets for help on using tickets.