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.

Sign up for GitHub

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

Jump to bottom

Fix docs bulding locally #639

Merged
merged 8 commits into from
Aug 29, 2023
Merged

Fix docs bulding locally #639

merged 8 commits into from
Aug 29, 2023

Conversation

unalmis
Copy link
Collaborator

@unalmis unalmis commented Aug 26, 2023 •
edited
Loading

No description provided.

unalmis added 3 commits August 26, 2023 12:10
@unalmis
Fix building docs locally
84d6bf0 
- Need to install pandoc from conda because the package through
  pip is not official and doesn't add the necessary hooks to work
  on most machines. See https://stackoverflow.com/questions/62398231/building-docs-fails-due-to-missing-pandoc.
@unalmis
Fix tex labels of some compute funs
8942657
@unalmis
Mention you need to install dev requirements
4056414
@codecov
Copy link

codecov bot commented Aug 26, 2023 •
edited
Loading

Codecov Report

Merging #639 (899da4b) into master (1669314) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #639      +/-   ##
==========================================
- Coverage   94.38%   94.37%   -0.01%     
==========================================
  Files          78       78              
  Lines       18521    18521              
==========================================
- Hits        17481    17480       -1     
- Misses       1040     1041       +1
Files Changed Coverage Δ
desc/compute/_basis_vectors.py 100.00% <ø> (ø)
desc/compute/_core.py 100.00% <ø> (ø)
desc/compute/_equil.py 100.00% <ø> (ø)
desc/compute/_field.py 100.00% <ø> (ø)
desc/compute/_geometry.py 81.57% <ø> (ø)
desc/compute/_metric.py 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

@dpanici
Copy link
Collaborator

dpanici commented Aug 28, 2023

Maybe also a good branch to resolve #636

After spending a couple hours, I don't think I can get #636 resolved in a reasonable amount of time, so I would not wait on it for this PR

@dpanici
Copy link
Collaborator

dpanici commented Aug 28, 2023 •
edited
Loading

While you are changing the docs/labels, could you fix a few of the labels where we have \partial{coord} instead of \partial_{coord}? e^rho_r and e^rho_theta are two examples of this
image

something as simple as doing a ctrl-f on "\\partial{\\rho}" and then replace all found instances with "\\partial_{\\rho}" (same for theta and zeta) should work I think

@dpanici
Copy link
Collaborator

dpanici commented Aug 28, 2023

Same thing for some of the higher derivatives
image

@unalmis
Add missing underscore to make characters subscripts
4852513 
Also remove e_zeta_t from a limit computation because it is always 0.
@unalmis unalmis requested a review from dpanici August 28, 2023 14:34
@unalmis unalmis merged commit c0b4441 into master Aug 29, 2023
@unalmis unalmis deleted the docs branch August 29, 2023 10:29
@unalmis unalmis added the documentation Add documentation or better warnings etc. label Jul 22, 2024
@unalmis unalmis self-assigned this Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dpanici dpanici dpanici approved these changes

@f0uriest f0uriest f0uriest approved these changes

Assignees

@dpanici dpanici

@pkim1818 pkim1818

@unalmis unalmis

Labels
documentation Add documentation or better warnings etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@unalmis @dpanici @f0uriest @pkim1818