Proof read Sphinx help docs

[smk78]

The new Sphinx help docs need proof reading for content, style, accuracy, compatibility with new/deprecated functionality, typos, grammar, etc.

[smk78]

All now parsed at 'Level 0', meaning they build in Sphinx.

[smk78]

Current status of proof reading is indicated by the presence/absence of a Sphinx note in each document (usually at the bottom)

[smk78]

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
kiessig_calculator_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)

fitting_help.rst
invariant_help.rst
pr_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst
slit_calculator_help.rst

[smk78]

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
kiessig_calculator_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)

fitting_help.rst
invariant_help.rst
pr_help.rst
slit_calculator_help.rst

[smk78]

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
invariant_help.rst
kiessig_calculator_help.rst
pr_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst
slit_calculator_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)

fitting_help.rst

[krzywon]

I took a look at fitting_help.rst but the sections "Single Fit" and "Simultaneous Fit" talk about choosing fitting engines (Scipy vs. Park). With the conversion to bumps, this is now all obsolete and needs a complete rewrite.

[smk78]

Noted.

I only just got to start 'proof-reading' this file at Code Camp so it is at present largely untouched.

Leave it with me!

[smk78]

The following have all been revisited to implement Sphinx sections/subsections and to remove unnecessary html-like internal links (as Sphinx auto builds a navigation tree):

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
invariant_help.rst
kiessig_calculator_help.rst
pr_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst
slit_calculator_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)

In progress:

What was fitting_help.rst ; this was a very lengthy help file covering both the help for the Fitting Perspective and help on technical/theoretical background matters such as polydispersity, smearing and magnetic scattering. The latter have been extracted to three new help files:

pd_help.rst
sm_help.rst
mag_help.rst

and a new second level toctree created:

fitting.rst

to provide a much cleaner route to fitting_help, pd_help, sm_help and mag_help, and to allow an EXTERNAL link to Paul Kienzle's Bumps documentation.

[smk78]

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
invariant_help.rst
kiessig_calculator_help.rst
pr_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst
slit_calculator_help.rst
+
fitting.rst
pd_help.rst
sm_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)
+
fitting_help.rst
mag_help.rst

[smk78]

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
invariant_help.rst
kiessig_calculator_help.rst
pr_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst
slit_calculator_help.rst
+
fitting.rst
pd_help.rst
sm_help.rst
mag_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)
+
fitting_help.rst

[smk78]

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
invariant_help.rst
kiessig_calculator_help.rst
pr_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst
slit_calculator_help.rst
fitting.rst
pd_help.rst
sm_help.rst
mag_help.rst
fitting_help.rst

To do:

model_functions.rst !!!
(but this should now be done model-by-model as the new model structure is implemented)

The porting and clean-up of all the old HTML help files into ReST is therefore complete and I am closing this ticket.