Update RTD documentation. (docstrings, changelog, documentation refactors)
Description
- Update Installation instructions. (Based on README.md)
- Remove AGIPD64k from available detectors to calibrate.
- Add
changelog.rst
- Expose
cal_tools
andxfel_calibrate
functions' docstrings - Refactor the documentations.
How Has This Been Tested?
Relevant Documents (optional)
Types of changes
- Docs (changes to the documentation)
- Refactor (refactoring code with no functionality changes)
Checklist:
- I have updated the documentation accordingly.
Reviewers
Edited by Karim Ahmed
Merge request reports
Activity
Filter activity
added In Progress label
added 135 commits
-
54e78cab...060ed13a - 134 commits from branch
master
- c81d0059 - resolve conflicts with master
-
54e78cab...060ed13a - 134 commits from branch
- Resolved by Karim Ahmed
This seems more like a large documentation overhaul than changes to
setup.py
@ahmedk The diff suggests it still adds lots of useful things, shall we review or is this outdated?
added 186 commits
-
8122441a...4b4341a0 - 168 commits from branch
master
- 921330de - Adjust CI for new setup.py requirements
- 9086414a - Update readme to reflect new setup method
- 7a1e14bb - Update testing method, add cov flags
- df0ed1e1 - Add notes on GitLab access from xcaltst
- 72a2fd6a - Sort extras
- c9b64d28 - Use importlib to check if XFELDetAna is installed
- 0c30bb27 - add mock up for imports
- a9c7aa89 - remove python req
- 09ae308f - avoid running notebooks
- ab13f164 - remove test_rsts
- 82dcdfec - put python check back
- 5d028ed2 - put back test and notebooks rst
- 01a0d0b3 - test removing cython mock
- 74c19b56 - update installation and how it works instructions
- fa6f8664 - remove AGIPD64 from available detectors
- d3be322a - start exposing functions
- cc743438 - Add more documentation and fixes
- 450b1e9e - update changelog
Toggle commit list-
8122441a...4b4341a0 - 168 commits from branch
added Waiting for review label and removed In Progress label
Please register or sign in to reply