Readthedocs diffsims API documentation?

[hakonanes]

kikuchipy now depends on diffsims for electron scattering and diffraction (namely the crystallography.ReciprocalLatticePoint class): pyxem/kikuchipy#220. I would therefore want the diffsims API to be easily browsable like kikuchipy's (https://kikuchipy.org/en/latest/reference.html) or orix' (https://orix.readthedocs.io/en/stable/reference.html).

The intersphinx functionality (click e.g. on the Rotation link in the "Parameters" docstring here: https://kikuchipy.org/en/latest/reference.html#kikuchipy.generators.EBSDSimulationGenerator) is also very nice, which becomes more important as kikuchipy depends more and more on orix (and hopefully diffsims).

I volunteer to set up a simple Readthedocs documentation available via https://diffsims.rtfd.io, as I did for orix.

[pc494]

Yes please @hakonanes, that would be great :)

[pc494]

Would this still work if we released it at a patch level? If so could we include it as well as the fix to #125 + whatever I find when making the demos into a 0.3.1?

[hakonanes]

Yes, shouldn't be a problem. Readthedocs only needs a config file and a doc directory to build from.

[hakonanes]

Made a v0.3.1 patch milestone to keep track of that release.

[pc494]

Great stuff, thank you :)