Skip to content

Update doc builder recommendations. - #327

Merged
samcunliffe merged 11 commits into
mainfrom
sc/187-update-docs-recommendations
Mar 25, 2024
Merged

Update doc builder recommendations.#327
samcunliffe merged 11 commits into
mainfrom
sc/187-update-docs-recommendations

Conversation

@samcunliffe

@samcunliffe samcunliffe commented Mar 24, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

Following the discussion in #16, I've tried to summarise (and might have quoted you directly 😄). Picky comments very gratefully received.

Fixes

Relates to

@samcunliffe
Update doc builder recommendations.
bff94dd 
Fixes #187.
Relates to #16, #318, and #319. See discussion in #16.
Depends on #319.
@samcunliffe samcunliffe added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 24, 2024
@samcunliffe samcunliffe linked an issue Mar 24, 2024 that may be closed by this pull request
Update documentation tooling recommendations #187
Closed
@samcunliffe

samcunliffe commented Mar 24, 2024

Copy link
Copy Markdown
Member Author

The link checker is expected to fail until #319 goes in.

@samcunliffe samcunliffe added the website Related to https://github-pages.arc.ucl.ac.uk/python-tooling label Mar 24, 2024
matt-graham
matt-graham requested changes Mar 25, 2024
View reviewed changes

@matt-graham matt-graham 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.

Added some very minor suggested changes, but otherwise looks great, thanks for summarizing the discussion points so well!

Comment thread docs/pages/docs.md Outdated
Comment thread docs/pages/docs.md Outdated
Comment thread docs/pages/docs.md
dstansby
dstansby reviewed Mar 25, 2024
View reviewed changes
Comment thread docs/pages/docs.md Outdated
Comment thread docs/pages/docs.md Outdated
Comment thread docs/pages/docs.md Outdated
Comment thread docs/pages/docs.md Outdated
Comment thread docs/pages/docs.md Outdated
Comment thread docs/pages/docs.md
samcunliffe and others added 2 commits March 25, 2024 11:01
@samcunliffe @matt-graham @dstansby
Suggestions from code review.
9925952 
Co-authored-by: Matt Graham <matthew.m.graham@gmail.com>
Co-authored-by: David Stansby <dstansby@gmail.com>
@samcunliffe @dstansby
GitHub pages may not be the simplest.
1a29442 
Co-authored-by: David Stansby <dstansby@gmail.com>
paddyroddy
paddyroddy approved these changes Mar 25, 2024
View reviewed changes

@paddyroddy paddyroddy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🫐

@dstansby

dstansby commented Mar 25, 2024

Copy link
Copy Markdown
Contributor

:shipit:

@samcunliffe
samcunliffe enabled auto-merge (squash) March 25, 2024 12:25
matt-graham
matt-graham reviewed Mar 25, 2024
View reviewed changes
Comment thread docs/pages/docs.md Outdated
samcunliffe and others added 2 commits March 25, 2024 15:49
@samcunliffe @matt-graham
api -> API
6ffb2f5 
Co-authored-by: Matt Graham <matthew.m.graham@gmail.com>
@samcunliffe
Merge branch 'main' into sc/187-update-docs-recommendations
00e66ca
@samcunliffe
samcunliffe requested a review from matt-graham March 25, 2024 15:50
matt-graham
matt-graham requested changes Mar 25, 2024
View reviewed changes

@matt-graham matt-graham left a comment •
edited
Loading

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.

A few minor capitalisation changes / acronym expansion, otherwise looks good.

EDIT: Sorry misclicked the Add single comment button previously for the other suggestion.

Comment thread docs/pages/docs.md Outdated
Comment thread docs/pages/docs.md Outdated
samcunliffe
samcunliffe commented Mar 25, 2024
View reviewed changes
Comment thread docs/pages/docs.md Outdated
samcunliffe
samcunliffe commented Mar 25, 2024
View reviewed changes
Comment thread docs/pages/docs.md Outdated
@samcunliffe @matt-graham
Revert lowercase barf.
b75137d 
Co-authored-by: Matt Graham <matthew.m.graham@gmail.com>
@samcunliffe
samcunliffe requested a review from matt-graham March 25, 2024 15:59
@samcunliffe
samcunliffe merged commit 06fd1b2 into main Mar 25, 2024
@samcunliffe
samcunliffe deleted the sc/187-update-docs-recommendations branch March 25, 2024 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@matt-graham matt-graham matt-graham approved these changes
@paddyroddy paddyroddy paddyroddy approved these changes
+1 more reviewer
@dstansby dstansby dstansby approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation enhancement New feature or request website Related to https://github-pages.arc.ucl.ac.uk/python-tooling

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update documentation tooling recommendations

4 participants

@samcunliffe @dstansby @matt-graham @paddyroddy