Ticket #7437 (closed: fixed)
Add calibration documentation to python docs
Reported by: | Gesner Passos | Owned by: | Gesner Passos |
---|---|---|---|
Priority: | major | Milestone: | Release 2.6 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | #7387 | |
Blocking: | Tester: | Martyn Gigg |
Description
Add the session of calibration to the python sphinx generated documentation.
Change History
comment:3 Changed 7 years ago by Gesner Passos
Tester:
Do not forget that #7387 must be passed first. Do not test this before.
After building mantid, you must build the python documentation.
make -j4 sphinx-html
So, open the python documentation inside the sphinx/html/index.html file. It must have a new session and a link called Calibration. Foolowing this link you should see the documentation of the calibration framework and some pictures as well.
comment:4 Changed 7 years ago by Gesner Passos
Configure sphinx to parse the tube calibration
re #7437
Changeset: bce375ab87e954bd969df36473cf6214f8660798
comment:5 Changed 7 years ago by Gesner Passos
Improve the connection of the parameters and its usage
re #7437
Changeset: 46a6193f7071bf5afa7ede1af2b647bd4a3c45e5
comment:6 Changed 7 years ago by Gesner Passos
- Status changed from accepted to verify
- Resolution set to fixed
comment:7 Changed 7 years ago by Wenduo Zhou
- Status changed from verify to verifying
- Tester set to Wenduo Zhou
comment:9 Changed 7 years ago by Wenduo Zhou
- Status changed from verifying to reopened
- Resolution fixed deleted
There is some conflict during merging feature/7437_doc_calibration.
git merge --no-ff origin/feature/7437_doc_calibration Auto-merging Code/Mantid/scripts/Calibration/tube.py CONFLICT (add/add): Merge conflict in Code/Mantid/scripts/Calibration/tube.py Automatic merge failed; fix conflicts and then commit the result.
comment:10 Changed 7 years ago by Gesner Passos
Merge remote-tracking branch 'origin/master' into feature/7437_doc_calibration
Conflicts:
Code/Mantid/scripts/Calibration/tube.py
It was necessary to merge master into 7437 to solve conflicts.
re #7437
Changeset: 3039afca224fedb5d0cf8afaf00272c8483a6d27
comment:11 Changed 7 years ago by Gesner Passos
- Status changed from reopened to verify
- Resolution set to fixed
I will not wait for checkbuild, because there were changes only at documentation (commented code). So, it is ready to be tested.
comment:12 Changed 7 years ago by Martyn Gigg
- Status changed from verify to verifying
- Tester changed from Wenduo Zhou to Martyn Gigg
comment:13 Changed 7 years ago by Martyn Gigg
- Status changed from verifying to verify
Merge remote-tracking branch 'origin/feature/7437_doc_calibration'
comment:17 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 8283