Improving development setup documentation #41
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kaushik-Iyer
changed the title
mariobehling
approved these changes
Feb 16, 2024
norbusan
approved these changes
Feb 16, 2024
|
@Kaushik-Iyer please redo this PR against |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While trying to build the documentation at https://docs.pretalx.org/developer/setup.html, I came across a step that might have been missed, specifically that of leaving the root directory and cd'ing into doc subdirectory first, before make html.
How has this been tested?
I built and ran the docs on my localhost, and this is how it looks now:
Checklist
doc/changelog.rst.