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 conda to docs #267

Merged
merged 4 commits into from
Jul 8, 2021
Merged

Add conda to docs #267

merged 4 commits into from
Jul 8, 2021

Conversation

ewu63
Copy link
Collaborator

@ewu63 ewu63 commented Jul 8, 2021

Purpose

I added information regarding conda, including installation instructions and a badge to the README. I also fixed some minor formatting issues in the RST files.

Type of change

What types of change is it?
Select the appropriate type(s) that describe this PR

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

There are no code changes.

Checklist

Put an x in the boxes that apply.

  • I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@ewu63 ewu63 requested a review from a team as a code owner July 8, 2021 14:28
@ewu63 ewu63 requested review from sseraj and ArshSaja July 8, 2021 14:28
@codecov
Copy link

codecov bot commented Jul 8, 2021

Codecov Report

Merging #267 (04e850e) into master (c3782fc) will decrease coverage by 0.12%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #267      +/-   ##
==========================================
- Coverage   83.65%   83.53%   -0.13%     
==========================================
  Files          22       22              
  Lines        3274     3274              
==========================================
- Hits         2739     2735       -4     
- Misses        535      539       +4     
Impacted Files Coverage Δ
pyoptsparse/pyOpt_MPI.py 67.64% <0.00%> (-11.77%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c3782fc...04e850e. Read the comment docs.

marcomangano
marcomangano previously approved these changes Jul 8, 2021
Copy link
Contributor

@marcomangano marcomangano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! We can go ahead and ignore the failed test on the TACC image, right?

@ewu63
Copy link
Collaborator Author

ewu63 commented Jul 8, 2021

Looks good! We can go ahead and ignore the failed test on the TACC image, right?

Yep exactly. Once we have the required reviews I can just merge this.

README.md Outdated Show resolved Hide resolved
@ewu63 ewu63 merged commit 9506f3e into master Jul 8, 2021
@ewu63 ewu63 deleted the add-conda-docs branch July 8, 2021 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants