search

chromatix-team / chromatix

Differentiable wave optics using JAX! Documentation can be found at https://chromatix.readthedocs.io
MIT License
77 stars 13 forks source link

Finish documentation #65

Closed GJBoth closed 6 months ago

schneidermc commented 1 year ago

I've noticed that the Seidel fitting has been added to the examples in the docs. Shall we add the Zernike fitting to the examples, too?

diptodip commented 1 year ago

Yes, we'll just need to turn it into a notebook like the Seidel example.

schneidermc commented 1 year ago

There should be already an existing notebook. It's possible that we only committed the .py, though. I will check and let you know.

schneidermc commented 1 year ago

Regarding the docs, is it possible to add some indents in the table of contents? E.g. have the PhaseMasks heading and then indent the subheadings (PhaseMask, SeidelAberrations, ZernikeAberrations etc.).

diptodip commented 1 year ago

Regarding the docs, is it possible to add some indents in the table of contents? E.g. have the PhaseMasks heading and then indent the subheadings (PhaseMask, SeidelAberrations, ZernikeAberrations etc.).

Yes, this is definitely something I need to fix. We just have to setup mkdocs correctly to handle the headings from the docstrings.

There should be already an existing notebook. It's possible that we only committed the .py, though. I will check and let you know.

That's right, I think I only got the .py. But I did also update the style of the Seidel notebook a bit. Thanks for checking!

diptodip commented 1 year ago

Regarding the docs, is it possible to add some indents in the table of contents? E.g. have the PhaseMasks heading and then indent the subheadings (PhaseMask, SeidelAberrations, ZernikeAberrations etc.).

So this should be fixed right now (might take some time/refreshing before it changes on readthedocs).