RocketPy icon indicating copy to clipboard operation
RocketPy copied to clipboard

TST: create tests to check if docs are rendering correctly

Open Gui-FernandesBR opened this issue 2 years ago • 1 comments

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 avatar Nov 14 '22 16:11 Gui-FernandesBR

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

giovaniceotto avatar Nov 14 '22 17:11 giovaniceotto