| | 1 | == Building the Help Docs == |
| | 2 | The process for building the help docs has been steadily evolving as we transition from ''!SasView'' 3.x to ''!SasView'' 4.x. This is because in ''!SasView'' 4.x the help documentation for each model is no longer standalone but actually an integral part of the model file itself. This in turn means that the model help documentation is no longer part of ''!SasView'' per se, rather it is part of our new model library called ''sasmodels''. |
| | 3 | |
| | 4 | To build the model help docs: |
| | 5 | |
| | 6 | Open a command window and ''cd'' to \sasmodels\doc |
| | 7 | |
| | 8 | {{{ |
| | 9 | make html |
| | 10 | }}} |
| | 11 | |
| | 12 | or (optionally) |
| | 13 | |
| | 14 | {{{ |
| | 15 | make clean html |
| | 16 | }}} |
| | 17 | |
| | 18 | This should populate the \sasmodels\doc\_build folder with a html folder containing html doc files, and copy these and their images to ''!SasView''. |
| | 19 | |
| | 20 | Now ''cd'' to \sasview\docs\sphinx-docs |
| | 21 | |
| | 22 | {{{ |
| | 23 | python build_sphinx.py |
| | 24 | }}} |
| | 25 | |
| | 26 | This should populate the \sasview\docs\build folder with an html folder containing the integrated ''!SasView'' and ''sasmodels'' html doc files. |
| | 27 | |
| | 28 | To check, open the file /sasview/docs/sphinx-docs/build/html/index.html in a web browser. |
| | 29 | |
| | 30 | '''Note: At the present time (June 2016) the ''bumps'' optimiser help docs are not being integrated.''' |
