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

docs: sphinx customisation #1165

Merged
merged 16 commits into from
Mar 28, 2024
Merged

docs: sphinx customisation #1165

merged 16 commits into from
Mar 28, 2024

Conversation

IronCore864
Copy link
Contributor

@IronCore864 IronCore864 commented Mar 26, 2024 •
edited
Loading

Customisation for sphinx starter pack.

There will be 3 PRs in total, this is PR 3/3, merge this one at last, after #1163 and #1164.

@IronCore864 IronCore864 marked this pull request as ready for review March 26, 2024 11:08
@IronCore864 IronCore864 mentioned this pull request Mar 26, 2024
Closed
IronCore864
IronCore864 commented Mar 27, 2024
View reviewed changes
docs/conf.py Outdated Show resolved Hide resolved
IronCore864
IronCore864 commented Mar 27, 2024
View reviewed changes
pyproject.toml Outdated Show resolved Hide resolved
@benhoyt benhoyt mentioned this pull request Mar 27, 2024
Merged
benhoyt
benhoyt reviewed Mar 27, 2024
View reviewed changes
Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Just some minor suggestions, and one question about the (possibly missing) Makefile?

CHANGES.md Outdated Show resolved Hide resolved
HACKING.md Outdated Show resolved Hide resolved
HACKING.md Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/custom_conf.py Outdated Show resolved Hide resolved
IronCore864 and others added 3 commits March 28, 2024 08:22
@IronCore864 @benhoyt
Update HACKING.md
cab87c9 
Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
@IronCore864 @benhoyt
Update CHANGES.md
c8fa321 
Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
@IronCore864
chore: move changes from conf to custom_conf
59796c1
@IronCore864 IronCore864 requested a review from benhoyt March 28, 2024 02:56
@IronCore864
Copy link
Contributor Author

Some updates:

  • build_requirements.py is still kept because conf.py imports from it
  • customisation is moved from conf.py to custom_conf.py
  • conf.py is still slightly changed because I need to remove the reusable links that we don't use
  • conf.py whole file is not lint any more

tonyandrewmeyer
tonyandrewmeyer approved these changes Mar 28, 2024
View reviewed changes
Copy link
Contributor

@tonyandrewmeyer tonyandrewmeyer left a comment

Choose a reason for hiding this comment

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

It feels a bit messy to me still that we combine building requirements in a clean starter pack clone and do everything else in ours, and how so much is vendored, but I think those are all things to be improved another day.

Looks good to merge to me, just a couple of very small suggestions.

CHANGES.md Outdated Show resolved Hide resolved
HACKING.md Outdated Show resolved Hide resolved
IronCore864 and others added 2 commits March 28, 2024 11:27
@IronCore864 @tonyandrewmeyer
Update CHANGES.md
5e4b862 
Co-authored-by: Tony Meyer <tony.meyer@gmail.com>
@IronCore864 @tonyandrewmeyer
Update HACKING.md
a1470ae 
Co-authored-by: Tony Meyer <tony.meyer@gmail.com>
benhoyt
benhoyt approved these changes Mar 28, 2024
View reviewed changes
Copy link
Collaborator

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

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

Looks good -- let's do this!

@IronCore864 IronCore864 merged commit 8bae12d into canonical:main Mar 28, 2024
28 checks passed
@IronCore864 IronCore864 deleted the read-the-docs-customisation branch March 28, 2024 04:22
@benhoyt benhoyt mentioned this pull request Apr 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benhoyt benhoyt benhoyt approved these changes

@tonyandrewmeyer tonyandrewmeyer tonyandrewmeyer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@IronCore864 @tonyandrewmeyer @benhoyt