X Tutup
Skip to content

DOC: Add documentation on how to build the docs#452

Merged
Gui-FernandesBR merged 4 commits intomasterfrom
doc/build-docs-page
Nov 7, 2023
Merged

DOC: Add documentation on how to build the docs#452
Gui-FernandesBR merged 4 commits intomasterfrom
doc/build-docs-page

Conversation

@Gui-FernandesBR
Copy link
Member

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 --runslow) have passed locally

Current behavior

Devs don't know how to build de documentation page locally, because we never explained them.

New behavior

It is a documentation on how to build the documentation.
Ironically, I can't build the docs right now due to a problem with netCDF4.
But trust me this works.

Breaking change

  • No

Additional information

See a preview on the readTheDocs page.

@Gui-FernandesBR Gui-FernandesBR added the Docs Docs and examples related label Nov 3, 2023
@Gui-FernandesBR
Copy link
Member Author

@MateusStano MateusStano added this to the Release v1.X.0 milestone Nov 3, 2023
Copy link
Member

@MateusStano MateusStano left a comment

Choose a reason for hiding this comment

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

Hey! This is really nice! I just made some small formatting changes in the last two commits. Please check it out, and merge whenever

@Gui-FernandesBR Gui-FernandesBR merged commit 59f091b into master Nov 7, 2023
@Gui-FernandesBR Gui-FernandesBR deleted the doc/build-docs-page branch November 9, 2023 21:53
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

No open projects
Status: Closed

Development

Successfully merging this pull request may close these issues.

2 participants

X Tutup