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

FIX: fixing docs error - 3rd attempt #210

Merged
merged 4 commits into from
Aug 20, 2022
Merged

Conversation

giovaniceotto
Copy link
Member

Pull request type

Please check the type of change your PR introduces:

  • Code base additions (bugfix, features)
  • Code maintenance (refactoring, formatting, renaming, tests)
  • ReadMe, Docs and GitHub maintenance
  • Other (please describe):

Pull request checklist

Please check if your PR fulfills the following requirements, depending on the type of PR:

  • ReadMe, Docs and GitHub maintenance:

    • Spelling has been verified
    • Code docs are working correctly

What is the current behavior?

Code documentation is empty: https://docs.rocketpy.org/en/latest/reference/classes/Function.html

What is the new behavior?

  • Fixes empty code documentation (by setting up a read the docs configuration file, setting it up to use python 3.9 instead of python 3.7 (required by Environment Analysis) and requesting it to install the requirements).

  • Adds Environment Analysis code documentation.

Preview: https://docs.rocketpy.org/en/hot_fix_documentation/reference/classes/Function.html

Does this introduce a breaking change?

  • Yes
  • No

@Gui-FernandesBR Gui-FernandesBR merged commit 5c65dec into master Aug 20, 2022
@Gui-FernandesBR
Copy link
Member

it was working perfectly on preview, but final version wasn't that good after merging...

image

@Gui-FernandesBR
Copy link
Member

Sorry too quick comment.. it takes a time until docs page refresh ... docs are passing but not all the classes are working on the code reference:

image

image

image

@giovaniceotto
Copy link
Member Author

It is probably due to cache. Check on your phone or an incognito tab.

@Gui-FernandesBR
Copy link
Member

Ok thanks for the tip, it's working fine and correctly now!

@Gui-FernandesBR Gui-FernandesBR deleted the hot_fix_documentation branch September 10, 2022 12:10
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