View Issue Details

IDProjectCategoryView StatusLast Update
0003601Slicer4Core: Documentation and Wikipublic2017-06-10 08:51
Reporterjcfr Assigned Tomatthew-woehlke  
PrioritynormalSeverityminorReproducibilityhave not tried
Status closedResolutionfixed 
Product Version 
Target VersionSlicer 4.4.0Fixed in VersionSlicer 4.4.0 
Summary0003601: Create developer documentation for new ExtensionWizard module
Description
  • Generation of documentation should be integrated with the existing process
  • Kitware sysadmin should be contacted to adapt the nightly script currently "scp-ing" the generated doxygen html archive.
TagsNo tags attached.

Relationships

related to 0003566 closedmatthew-woehlke Wizard: Simplify creation of extensions and modules 
has duplicate 0003572 closedjcfr Add ExtensionWizard wiki page 
related to 0003727 closedjcfr Update BuildTestPackageDistributeExtensions page to use the latest and greatest extension wizard feature 
child of 0003269 closedmatthew-woehlke Simplify process for contributing scripted modules to the extensions catalog 

Activities

jcfr

jcfr

2014-02-28 05:31

administrator   ~0010653

Last edited: 2014-02-28 05:31

See http://mwoehlke-kitware.github.io/Slicer/SlicerWizard/

matthew-woehlke

matthew-woehlke

2014-03-28 09:00

developer   ~0011483

Changes to doc targets and to create a tarball for the SlicerWizard doc can be found at https://github.com/mwoehlke-kitware/Slicer/tree/3601-create-slicerwizard-doc-tarball.

After merge, we'll still need to update the scp scripts and arrange to unpack the SlicerWizard documentation to an appropriate place.

inorton

inorton

2014-04-17 12:06

developer   ~0011601

It would be nice to include the wizard in the binary distribution too, especially for Windows.

jcfr

jcfr

2014-04-17 20:47

administrator   ~0011607

@Isaiah: That is the plan. See 0003269, 0003603 and http://wiki.slicer.org/slicerWiki/index.php/Documentation/Labs/ExtensionsFrameworkRoadmap#Progress

jcfr

jcfr

2014-05-19 11:27

administrator   ~0011898

Please, integrate associated commit into Slicer trunk.

The sysadmin have been notified and the scp'ing rules should be updated for tomorrow.

matthew-woehlke

matthew-woehlke

2014-05-19 13:39

developer   ~0011902

Slicer changes integrated as r23209 - r23211.

jcfr

jcfr

2014-05-19 22:41

administrator   ~0011907

After installing the latest version of sphinx, GitPython and PyGithub, on the factory (python 2.6), I got few errors similar to this one:

8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----
/home/kitware/Dashboards/Nightly/Slicer4/Utilities/Scripts/SlicerWizard/doc/SlicerWizard.rst:73: WARNING: autodoc: failed to import class u'WizardHelpFormatter' from module u'SlicerWizard'; the following exception was raised:
Traceback (most recent call last):
File "/usr/local/lib/python2.6/dist-packages/sphinx/ext/autodoc.py", line 335, in import_object
import(self.modname)
File "/home/kitware/Dashboards/Nightly/Slicer4/Utilities/Scripts/SlicerWizard/init.py", line 44, in <module>
from .ExtensionWizard import ExtensionWizard
File "/home/kitware/Dashboards/Nightly/Slicer4/Utilities/Scripts/SlicerWizard/ExtensionWizard.py", line 26, in <module>
from .TemplateManager import TemplateManager
File "/home/kitware/Dashboards/Nightly/Slicer4/Utilities/Scripts/SlicerWizard/TemplateManager.py", line 5, in <module>
from .Utilities import die
File "/home/kitware/Dashboards/Nightly/Slicer4/Utilities/Scripts/SlicerWizard/Utilities.py", line 275
if not _haveGit or tool not in { None, "git" }:
8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----

Then, by replacing line 275, 320 and 343 with:

[...] or tool not in [ None, "git" ]:

instead of

[...] or tool not in { None, "git" }:

and also line 329

if tool in [ None, "svn" ]:

instead of

if tool in { None, "svn" }:

... things behave even when using python 2.6.

If this solution sounds reasonable, could you push a fix ?

Thanks

matthew-woehlke

matthew-woehlke

2014-05-20 11:57

developer   ~0011927

bah... set literals are a 2.7 addition?? sigh...

matthew-woehlke

matthew-woehlke

2014-05-20 12:02

developer   ~0011928

https://github.com/mwoehlke-kitware/Slicer/tree/fix-wizard-python26-support should fix this?

jcfr

jcfr

2014-05-20 12:33

administrator   ~0011929

Looks good. Please integrate.

matthew-woehlke

matthew-woehlke

2014-05-20 13:35

developer   ~0011930

Above mentioned issue fixed in r23219.

Related Changesets

Import 2017-06-07 23:51:09: master 1f4b8351

2014-05-19 17:31:58

mwoehlke

Details Diff
ENH: Generate tarball of SlicerWizard doc

Create a new build target to generate a tarball of the SlicerWizard
documentation. This is meant to be used similar to the existing Doxygen
tarball, to be scp'd or otherwise transferred from a build machine to
another machine which will serve the pages publicly.

Issue 0003601

git-svn-id: http://svn.slicer.org/Slicer4/trunk@23209 3bd1e089-480b-0410-8dfb-8563597acbee
mod - Utilities/Scripts/SlicerWizard/doc/CMakeLists.txt Diff File
add - Utilities/Scripts/SlicerWizard/doc/create_doc_tarball.cmake Diff File

Issue History

Date Modified Username Field Change
2014-02-28 05:28 jcfr New Issue
2014-02-28 05:28 jcfr Status new => assigned
2014-02-28 05:28 jcfr Assigned To => jcfr
2014-02-28 05:29 jcfr Relationship added related to 0003572
2014-02-28 05:31 jcfr Summary Create documentation for new ExtensionWizard module => Create developer documentation for new ExtensionWizard module
2014-02-28 05:31 jcfr Note Added: 0010653
2014-02-28 05:31 jcfr Note Edited: 0010653
2014-02-28 05:31 jcfr Assigned To jcfr => matthew-woehlke
2014-02-28 05:32 jcfr Target Version => Slicer 4.4.0
2014-02-28 05:43 jcfr Relationship added child of 0003269
2014-02-28 05:43 jcfr Relationship added child of 0003566
2014-03-12 12:16 jcfr Relationship replaced related to 0003566
2014-03-28 09:00 matthew-woehlke Note Added: 0011483
2014-03-28 09:00 matthew-woehlke Status assigned => feedback
2014-04-17 12:06 inorton Note Added: 0011601
2014-04-17 20:47 jcfr Note Added: 0011607
2014-05-12 11:45 jcfr Relationship replaced has duplicate 0003572
2014-05-19 11:27 jcfr Note Added: 0011898
2014-05-19 11:27 jcfr Status feedback => assigned
2014-05-19 13:39 matthew-woehlke Note Added: 0011902
2014-05-19 13:39 matthew-woehlke Status assigned => resolved
2014-05-19 13:39 matthew-woehlke Resolution open => fixed
2014-05-19 22:41 jcfr Note Added: 0011907
2014-05-19 22:41 jcfr Status resolved => assigned
2014-05-20 11:57 matthew-woehlke Note Added: 0011927
2014-05-20 12:02 matthew-woehlke Note Added: 0011928
2014-05-20 12:02 matthew-woehlke Status assigned => feedback
2014-05-20 12:33 jcfr Note Added: 0011929
2014-05-20 12:33 jcfr Status feedback => assigned
2014-05-20 13:35 matthew-woehlke Note Added: 0011930
2014-05-20 13:35 matthew-woehlke Status assigned => resolved
2014-06-03 13:59 jcfr Relationship added related to 0003727
2014-06-04 06:08 jcfr Status resolved => closed
2014-06-04 06:08 jcfr Fixed in Version => Slicer 4.4.0
2016-06-20 14:15 jcfr Category Core: Documentation & Wiki => Core: Documentation and Wiki
2017-06-10 08:51 Changeset attached => Slicer master 1f4b8351