Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add formulas to indices docs #400

Merged
merged 2 commits into from
Feb 20, 2022
Merged

Add formulas to indices docs #400

merged 2 commits into from
Feb 20, 2022

Conversation

adamjstewart
Copy link
Collaborator

See #387

We may need to develop a consistent naming scheme for bands. For example, some indices take in the index of the red-edge band, but many satellites don't have a red-edge band, so we use red instead. The parameter names should be somehow consistent in this scenario.

I haven't yet added common use cases and interpretation to the docs. That can probably be done in a separate PR.

@github-actions github-actions bot added documentation Improvements or additions to documentation transforms Data augmentation transforms labels Feb 15, 2022
@adamjstewart adamjstewart added this to the 0.3.0 milestone Feb 18, 2022
@calebrob6
Copy link
Member

The formulas look really small (e.g. https://torchgeo--400.org.readthedocs.build/en/400/api/transforms.html), is it just me?

image

@adamjstewart
Copy link
Collaborator Author

Looks normal to me on macOS with Chrome:
Screen Shot 2022-02-20 at 1 59 37 PM

@calebrob6
Copy link
Member

Cool, going to assume it is just me (maybe some weird global mathjax settings I have?)

@calebrob6 calebrob6 merged commit 170d595 into main Feb 20, 2022
@calebrob6 calebrob6 deleted the docs/indices branch February 20, 2022 20:09
@adamjstewart
Copy link
Collaborator Author

If other people report the same problem there are other options: https://www.sphinx-doc.org/en/master/usage/extensions/math.html

I chose mathjax because it seemed simpler than imgmath (which requires LaTeX to build image files) and newer than jsmath (seems like an older version of mathjax). There are many third-party options as well (PyTorch uses sphinxcontrib.katex)

@adamjstewart adamjstewart mentioned this pull request Jul 11, 2022
yichiac pushed a commit to yichiac/torchgeo that referenced this pull request Apr 29, 2023
* Add formulas to indices docs

* Use math text mode
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation transforms Data augmentation transforms
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants