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

Added docs package requirements to setup.py #290

Merged
merged 5 commits into from
Apr 4, 2022
Merged

Added docs package requirements to setup.py #290

merged 5 commits into from
Apr 4, 2022

Conversation

marcomangano
Copy link
Contributor

Purpose

As per title, now if the user wants to build the documentation locally, they can set all the dependencies using pip install .[docs]

Expected time until merged

as soon as the tests pass?

Type of change

  • 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)

Checklist

  • 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

@marcomangano marcomangano requested a review from a team as a code owner April 2, 2022 19:34
@codecov
Copy link

codecov bot commented Apr 2, 2022

Codecov Report

Merging #290 (6301b23) into main (c55b4ea) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #290   +/-   ##
=======================================
  Coverage   84.16%   84.16%           
=======================================
  Files          22       22           
  Lines        3315     3315           
=======================================
  Hits         2790     2790           
  Misses        525      525           
Impacted Files Coverage Δ
pyoptsparse/__init__.py 100.00% <100.00%> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

ewu63
ewu63 previously approved these changes Apr 2, 2022
Copy link
Collaborator

@sseraj sseraj left a comment

Choose a reason for hiding this comment

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

Should we also prune requirements.txt (here and in other repos)? numpydoc and sphinxcontrib-bibtex are both already required by sphinx_mdolab_theme.

@ewu63
Copy link
Collaborator

ewu63 commented Apr 3, 2022

Yes that'd be a good idea. I started adding dependencies to the mdolab theme but haven't gotten around to pruning the repos.

@ewu63
Copy link
Collaborator

ewu63 commented Apr 3, 2022

I think we should also bump the patch version here.

@sseraj sseraj merged commit a4ae1b1 into main Apr 4, 2022
@sseraj sseraj deleted the docs-require branch April 4, 2022 18:09
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