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

DOC: Fix documentation warnings #645

Merged
merged 3 commits into from
Aug 4, 2024

Conversation

Gui-FernandesBR
Copy link
Member

@Gui-FernandesBR Gui-FernandesBR commented Jul 20, 2024

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • Tests for the changes have been added (if needed)
  • Docs have been reviewed and added / updated
  • Lint (black rocketpy/ tests/) has passed locally
  • All tests (pytest tests -m slow --runslow) have passed locally
  • CHANGELOG.md has been updated (if relevant)

New behavior

Solves warnings and deprecations.

The main file you should care when reviewing is the conf.py file. All the rest are just tiny details that I've adjusted to fix the warning that are displayed by the documentation building process.

Breaking change

  • No

@Gui-FernandesBR Gui-FernandesBR requested a review from a team as a code owner July 20, 2024 21:11
@Gui-FernandesBR Gui-FernandesBR added the Docs Docs and examples related label Jul 20, 2024
Copy link

codecov bot commented Jul 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.75%. Comparing base (aa0673a) to head (ed900e5).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #645   +/-   ##
========================================
  Coverage    75.75%   75.75%           
========================================
  Files           81       81           
  Lines         9820     9820           
========================================
  Hits          7439     7439           
  Misses        2381     2381           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Gui-FernandesBR Gui-FernandesBR force-pushed the doc/environment-docs-refactor branch from 054fcc2 to 6f31762 Compare July 20, 2024 22:23
@Gui-FernandesBR Gui-FernandesBR force-pushed the doc/environment-docs-refactor branch 4 times, most recently from 747e5cf to e3c2230 Compare August 3, 2024 16:10
Base automatically changed from doc/environment-docs-refactor to develop August 3, 2024 16:14
@Gui-FernandesBR Gui-FernandesBR force-pushed the doc/fix-documentation-warnings branch from f3cc0e5 to 10fe81b Compare August 3, 2024 16:16
Gui-FernandesBR added a commit that referenced this pull request Aug 3, 2024
@Gui-FernandesBR Gui-FernandesBR linked an issue Aug 3, 2024 that may be closed by this pull request
Copy link
Collaborator

@phmbressan phmbressan left a comment

Choose a reason for hiding this comment

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

Good job on tackling so many warnings. The changes regarding math inputs, LaTeX, text clarity etc are much welcome.

Gui-FernandesBR and others added 3 commits August 4, 2024 01:17
STY: fix flake8

DOC: fix more warnings

DEV: Adds #645 to changelog

DOC: fix broken links
DOC: fix minor fixes
@Gui-FernandesBR Gui-FernandesBR force-pushed the doc/fix-documentation-warnings branch from 9b5bf5a to 9f98b58 Compare August 4, 2024 04:17
@Gui-FernandesBR Gui-FernandesBR merged commit b21b452 into develop Aug 4, 2024
3 of 7 checks passed
Gui-FernandesBR added a commit that referenced this pull request Aug 4, 2024
STY: fix flake8

DOC: fix more warnings

DEV: Adds #645 to changelog

DOC: fix broken links
@Gui-FernandesBR Gui-FernandesBR deleted the doc/fix-documentation-warnings branch August 4, 2024 04:21
juliomachad0 pushed a commit that referenced this pull request Aug 24, 2024
STY: fix flake8

DOC: fix more warnings

DEV: Adds #645 to changelog

DOC: fix broken links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

DOC: The "First Simulation with RocketPy" Notebook File fails
3 participants