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.

Sign up for GitHub

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

Jump to bottom

Update doc builder recommendations. #327

Merged
merged 11 commits into from
Mar 25, 2024
Merged

Update doc builder recommendations. #327

merged 11 commits into from
Mar 25, 2024

Conversation

samcunliffe
Copy link
Member

@samcunliffe samcunliffe commented Mar 24, 2024 •
edited
Loading

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
Copy link
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
Copy link
Collaborator

@matt-graham matt-graham left a comment

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!

docs/pages/docs.md Outdated Show resolved Hide resolved
docs/pages/docs.md Outdated Show resolved Hide resolved
docs/pages/docs.md Show resolved Hide resolved
dstansby
dstansby reviewed Mar 25, 2024
View reviewed changes
docs/pages/docs.md Outdated Show resolved Hide resolved
docs/pages/docs.md Outdated Show resolved Hide resolved
docs/pages/docs.md Outdated Show resolved Hide resolved
docs/pages/docs.md Outdated Show resolved Hide resolved
docs/pages/docs.md Outdated Show resolved Hide resolved
docs/pages/docs.md Show resolved Hide resolved
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
Copy link
Member

@paddyroddy paddyroddy left a comment

Choose a reason for hiding this comment

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

🫐

@dstansby
Copy link
Member

:shipit:

@samcunliffe samcunliffe enabled auto-merge (squash) March 25, 2024 12:25
matt-graham
matt-graham reviewed Mar 25, 2024
View reviewed changes
docs/pages/docs.md Outdated Show resolved Hide resolved
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
matt-graham
matt-graham requested changes Mar 25, 2024
View reviewed changes
Copy link
Collaborator

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

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.

docs/pages/docs.md Outdated Show resolved Hide resolved
docs/pages/docs.md Outdated Show resolved Hide resolved
samcunliffe
samcunliffe commented Mar 25, 2024
View reviewed changes
docs/pages/docs.md Outdated Show resolved Hide resolved
samcunliffe
samcunliffe commented Mar 25, 2024
View reviewed changes
docs/pages/docs.md Outdated Show resolved Hide resolved
@samcunliffe @matt-graham
Revert lowercase barf.
b75137d 
Co-authored-by: Matt Graham <matthew.m.graham@gmail.com>
@samcunliffe samcunliffe merged commit 06fd1b2 into main Mar 25, 2024
15 checks passed
@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

@dstansby dstansby dstansby approved these changes

@matt-graham matt-graham matt-graham approved these changes

@paddyroddy paddyroddy paddyroddy approved these changes

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