search

SasView / sasmodels

Package for calculation of small angle scattering models using OpenCL.
BSD 3-Clause "New" or "Revised" License
15 stars 27 forks source link

Update scripting Part Deux #532

Closed smk78 closed 1 year ago

smk78 commented 1 year ago

This PR partially reverts recent changes already made to scripting.rst in favour of locating the doc strings in sas\cli.py. See https://github.com/SasView/sasview/pull/2280

wpotrzebowski commented 1 year ago

Hmm, no clue why ubuntu test is failing. There is a warning generated but don't think it is what causing and error /home/runner/work/sasmodels/sasmodels/doc/guide/scripting.rst:50: WARNING: py:mod reference target not found: sas.cli?

smk78 commented 1 year ago

Ok, I'm making a change here to fix the failing Ubuntu tests. The issue is that I'd added a link to the new sasview command line syntax in scripting.rst. But scripting.rst is a sasmodels doc file, so an error is thrown when the sasmodels docs build but the link was resolving when the full (sasmodels+sasview) docs built! The last commit removes the link to the command line syntax from scripting.rst. Instead I'm going to add a link to the command line syntax from the sasview 'Working with SasView' toctree. And then, so that the link to the scripting interface help (scripting.rst) is not orphaned from this I'm going to move it from 'Fitting Help' to 'Working with SasView'. It's a little ugly but I don't see another way of preserving the independence of sasmodels & sasview. Also see https://github.com/SasView/sasview/pull/2280

smk78 commented 1 year ago

So just to illustrate what I've done: image and image