Skip to content

42 docs fill out - #46

Merged
wathen merged 8 commits into
mainfrom
42-docs_fill_out
Sep 11, 2026
Merged

wathen merged 8 commits into
mainfrom
42-docs_fill_out

Conversation

@wathen

@wathen wathen commented Aug 26, 2026

Copy link
Copy Markdown
Member

Summary

  • Cleaned the documentation homepage, README, installation page, contributor guide, and release-facing placeholder text.
  • Fixed documentation version handling, TODO visibility, acknowledgements, and stale dependency/license references.
  • Aligned warning policy so documentation builds fail consistently on Sphinx warnings.

Related issue

Closes #41


Type of change

Select all that apply:

  • [x ] Bug fix
  • New feature
  • Code port
  • Refactor
  • [ x] Documentation update
  • Test update
  • [x ] Build / CI change
  • Other: <describe>

@wathen
wathen requested a review from danclewley August 26, 2026 09:57
@wathen
wathen marked this pull request as draft August 26, 2026 10:00
@wathen

wathen commented Aug 26, 2026

Copy link
Copy Markdown
Member Author

Will fix tests once #45 has been reviewed and merged

@wathen
wathen removed the request for review from danclewley August 26, 2026 10:09
@wathen
wathen marked this pull request as ready for review September 3, 2026 16:18
@wathen
wathen requested a review from danclewley September 3, 2026 16:18

@danclewley danclewley left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Changes look good to me. I agree having it fail rather than publish if the package version can't be resolved is better behaviour.

@wathen
wathen merged commit d460c18 into main Sep 11, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc build errors

2 participants