Opened 19 months ago

Closed 6 months ago

#555 closed defect (fixed)

build_sphinx.py needs cleanup

Reported by: butler Owned by: ajj
Priority: major Milestone: SasView Next Release +1
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

Description (last modified by butler)

The build module should properly cleanout everything before rebuilding. Also if a destination directory does not exist it should be created. Currently there are several instances of checking for existence but failing to create if not true -- the script just goes on happily to next if statement leaving no message of why the end product cannot build properly. It should also exclude irrelevant files from the document scrapping (such as setup.exe and setup.mac). Finally, the current build script for 4.0 copies down the pre-assembled .rst model help files from sasmodels package so that one must make sure to *first* build the sasmodels docs before building the SasView docs in order for integrated documentation to be built correctly. In the future this should not be a required step every time one builds the SasView docs.

There may be other things as well which should be added to this ticket as they become known - note that sasmodel package specific issues should be reported in separate tickets.

Change History (6)

comment:1 Changed 19 months ago by butler

  • Description modified (diff)

comment:2 Changed 19 months ago by smk78

I think this ticket is referring to a number of tests I put in whilst trying to integrate the sasmodels docs. Trying to figure out paths was a nightmare!

Yes the build is ugly now. But the relevant build folders were/are cleaned out before the build, and I haven't seen any builds failing because of a missing folder. Do you have an example???

I've no idea why setup_exe and setup_mac are being touched.

But as #554 says there needs to a more strategic overview of how things are arranged and sorting out build_sphinx will be part of that.

So I kinda think this ticket is redundant?

comment:3 Changed 19 months ago by butler

  • Description modified (diff)

comment:4 Changed 19 months ago by butler

The main part of the ticket has now been edited as has ticket #554 to clarify the difference between this tickets (one is a sasmodels ticket the other a SasView ticket.

comment:5 Changed 13 months ago by ajj

  • Owner set to ajj
  • Status changed from new to assigned

comment:6 Changed 6 months ago by GitHub <noreply@…>

  • Resolution set to fixed
  • Status changed from assigned to closed

In a42fb8e0cf6996ebf17dc91335740bbd521db137/sasview:

Merge pull request #87 from SasView?/ticket-555

Closes #555

Note: See TracTickets for help on using tickets.