Version 1.2 documentation

[ChristopherChudzicki]

• [x] documentation for MatrixGrader
  • course examples:
    • [x] basic example illustrating algebra, non-commutative behavior, error messages
    • [x] matrix entry-by-entry input example
    • [x] cross product example
    • [x] example highlighting vector vs single-row-matrix vs single-column-matrix
• [x] documentation for vector/matrix sampling classes
• [x] specify_domain documentation
  • [x] course example
• [x] document comparer_functions
  • [x] NumericalGrader course example using is_between comparer
  • [x] MatrixGrader course example using eigenvector/eigenvalue comparer
  • [x] ListGrader eigenvalue/eigenvector comparer demo
• [x] documentation for sibling variables when FormulaGrader used in ListGrader
  • [x] course examples
• [x] consolidate index.md and getting_starting.md (there was a lot of overlap)

Some of these are very close to done.

My version of the documentation website My version of demo course

Note: I changed the theme to mkdocs-cinder, because I wanted one level deeper on the individual page table of contents. Could explore other themes, but not going to worry about it now.

[ChristopherChudzicki]

@jolyonb This is going to be a pretty big PR. I updated the to-do list at the top. No rush at all, but if you want to look at any of it, I consider what's been pushed to be ready-for-review.

My goal will be to finish some of the course demos for comparer_functions before tomorrow's meetings. (But I probably won't write the website documention for it before the meetings. )

[jolyonb]

I'm sure this one is going to be huge -- we're catching up on two months' worth of features! I'm going to hold off on looking/making comments until you're done, I think.

I agree that focusing on some course demos for tomorrow's meeting(s?) is probably a good idea.

[jolyonb]

Can we make a standalone module of comparison functions, rather than having them scattered about randomly?

[ChristopherChudzicki]

Can we make a standalone module of comparison functions, rather than having them scattered about randomly?

Sure! This was my original inclination, though MatrixGrader comparer_functions get a few extra utils.

[jolyonb]

I much prefer a standalone module. I think we should be able to figure out how to make something that works with the appropriate utils ;-) It can be exposed in a comparers module.

[ChristopherChudzicki]

@jolyonb Ready for review. My version of the demo course and website are update, see PR summary.

[ChristopherChudzicki]

rebased to fix merge conflicts

[jolyonb]

Thanks. I'm going to try to do the programmatic part of this tomorrow morning.

[jolyonb]

I'm merging this now, and will make updates in a future PR.