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

TST: create tests to check if docs are rendering correctly #297

Open
Gui-FernandesBR opened this issue Nov 14, 2022 · 1 comment
Open

TST: create tests to check if docs are rendering correctly #297

Gui-FernandesBR opened this issue Nov 14, 2022 · 1 comment
Labels
Docs Docs and examples related Tests Regarding Tests

Comments

@Gui-FernandesBR
Copy link
Member

Describe the bug

When accessing the documentation of the Rocket.addTrapezoidalFins method. The docs that are built are not following the correct format.

To Reproduce

Just access the following link: (https://docs.rocketpy.org/en/latest/reference/classes/Rocket.html?highlight=addtrapezo#rocketpy.Rocket.Rocket.addTrapezoidalFins)

Expected behavior

Something like this whoud happen:
image

Screenshots

image

Additional context

This issue was reported by an user in our discord server. I'm saving here so we don't forget it!

@Gui-FernandesBR Gui-FernandesBR added the Docs Docs and examples related label Nov 14, 2022
@giovaniceotto
Copy link
Member

May be useful to prevent future errors similar to this: https://stackoverflow.com/questions/33896196/how-to-test-the-validity-of-your-sphinx-documentation

@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.1.0 milestone May 26, 2023
@Gui-FernandesBR Gui-FernandesBR changed the title addTrapezoidalFins docs not rendering corretly TST: unit tests to check if docs are rendering correctly Sep 5, 2023
@Gui-FernandesBR Gui-FernandesBR added the Tests Regarding Tests label Oct 30, 2023
@Gui-FernandesBR Gui-FernandesBR removed their assignment Dec 25, 2023
@Gui-FernandesBR Gui-FernandesBR changed the title TST: unit tests to check if docs are rendering correctly TST: create tests to check if docs are rendering correctly May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related Tests Regarding Tests
Projects
Status: Mid-Term
Development

No branches or pull requests

2 participants