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

Adds more documentation and guidelines. #6

Merged
merged 10 commits into from
Jul 10, 2023
Merged

Conversation

aerorahul
Copy link
Contributor

@aerorahul aerorahul commented Jul 10, 2023

Description
This PR:

  • uses the Furo sphinx style as it makes it look a lot cleaner (personal opinion). The documentation from this PR is viewable here
  • adds guides in the documentation
  • also adds references to API
  • Adds language for tools we use for checking norms (isort, black and flake8). This should make @HenryWinterbottom-NOAA happy. The next PR will reformat to remove the errors from black and flake8.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

  • pytests

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published

@codecov
Copy link

codecov bot commented Jul 10, 2023

Codecov Report

❗ No coverage uploaded for pull request base (develop@528f5ab). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             develop       #6   +/-   ##
==========================================
  Coverage           ?   48.91%           
==========================================
  Files              ?       15           
  Lines              ?     1429           
  Branches           ?      305           
==========================================
  Hits               ?      699           
  Misses             ?      676           
  Partials           ?       54           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@aerorahul aerorahul merged commit f084062 into develop Jul 10, 2023
15 checks passed
@aerorahul aerorahul deleted the feature/formatting branch July 10, 2023 17:23
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.

None yet

2 participants