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

Update the how to build Rebel Documentation locally page #24

Merged

Conversation

madmiraal
Copy link
Contributor

@madmiraal madmiraal commented Jun 10, 2024

To update Rebel Documentation, contributors can make smaller changes here on GitHub directly. However, when making anything more than minor changes, contributors will most likely create a local copy of the Rebel Documentation repository and make changes locally on their computer. When making significant changes to Rebel Documentation (including how to update Rebel Documentation) it is useful to see the effect of your changes before creating a Pull Request. Therefore, before we can make significant updates to Rebel Documentation, one of the first things we need to update is how to build and view the Rebel Documentation locally. This PR creates the Building Rebel Documentation with Sphinx page, which replaces the current Building the manual with Sphinx page.

@madmiraal madmiraal added the PR Type: Improvement Improves the content. label Jun 10, 2024
@madmiraal madmiraal force-pushed the update-building-the-documentation branch from 301e39e to 3ba5614 Compare June 10, 2024 19:10
@DanielaOrtner DanielaOrtner self-requested a review June 22, 2024 14:16
Co-authored-by: Daniela Ortner <19823123+DanielaOrtner@users.noreply.github.com>
@madmiraal madmiraal force-pushed the update-building-the-documentation branch from ceb6255 to 6aedbff Compare June 22, 2024 16:21
@DanielaOrtner DanielaOrtner self-requested a review June 22, 2024 17:01
Copy link
Contributor

@DanielaOrtner DanielaOrtner left a comment

Choose a reason for hiding this comment

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

Great work! Thanks for looking at the suggestions so quickly.

@DanielaOrtner DanielaOrtner merged commit ba5d62a into RebelToolbox:main Jun 22, 2024
3 checks passed
@madmiraal madmiraal deleted the update-building-the-documentation branch June 23, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR Type: Improvement Improves the content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants