Docs/add docs generation guide #2220
Merged
Conversation
This file contains hidden or 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
tim-schilling
requested changes
Oct 9, 2025
There was a problem hiding this comment.
Thank you @okotdaniel! This is really great. Seeing the documentation so well written is solidifying some of my thoughts. I apologize for not having these entirely thought out when we created the issue.
If you disagree with any of my thoughts, please let me know. And where I ask questions, I would like your feedback. Thank you!
tim-schilling
approved these changes
Oct 10, 2025
for more information, see https://pre-commit.ci
Co-authored-by: Tim Schilling <schilling711@gmail.com>
for more information, see https://pre-commit.ci
tim-schilling
force-pushed
the
docs/add-docs-generation-guide
branch
from
005e633 to
57f9abb
Compare
|
I've rebased on main, fixed the pre-commit errors due to I'm going to squash these commits and merge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This pull request adds a new section to the contributing documentation that explains how to build and preview the project documentation locally using Make and Tox.
Previously, contributors did not have clear instructions on generating the documentation before submitting changes.
This update provides step-by-step guidance for both Linux/macOS and Windows users, ensuring a smoother onboarding experience for new contributors.
Fixes #2215
Checklist:
docs/changes.rst.