GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Previews in pull requests by hugovk · Pull Request #105 · python/python-docs-theme

Conversation

@hugovk

@hugovk hugovk commented Jan 31, 2023 •
edited by pradyunsg
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Fixes #70.

#70 suggested Read the Docs and Netlify, but we have a bit of a bus factor problem with Netlify on the CPython docs due to only having a single account that can access the admin, so let's use Read the Docs as well. We're using it successfully in the PEPs repo.

Here's a demo build:

  • https://readthedocs.org/projects/hugovk-python-docs-theme/builds/19337266/
  • https://hugovk-python-docs-theme.readthedocs.io/en/rtd-preview/

Draft because:

  • This builds upon create Makefile for faster iteration #93 plus my suggestions. I'll rebase after it's merged.

And we need to set up Read the Docs:

  • Someone with admin to this repo (because it needs to set up the webhooks; I don't have admin) should import it at https://readthedocs.org/dashboard/import/
  • I suggest we use the python-docs-theme-previews slug (consistent with peps-previews at https://github.com/python/peps)
  • Add some more maintainers at https://readthedocs.org/dashboard/python-docs-theme-previews/users/ to improve bus factor

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@hugovk hugovk mentioned this pull request Jan 31, 2023
Previews in pull requests #70
Closed
@hugovk

hugovk commented Feb 6, 2023

Copy link
Copy Markdown
Member Author

Ping @Mariatta

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JDLH

JDLH commented Feb 6, 2023

Copy link
Copy Markdown

I wasn't aware of the term "bus factor". For the information of others like me, it refers to a risk that critical roles in a project are limited to a small number of people, in the sense of "in case they get hit by a bus". There is a nice Wikipedia article, Bus factor.

hugovk reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk hugovk changed the title Build CPython docs on Read the Docs Previews in pull requests Feb 6, 2023
@Mariatta

Mariatta commented Feb 6, 2023

Copy link
Copy Markdown
Member

Project created: https://readthedocs.org/projects/python-docs-theme-previews/

Who else should I add as maintainers?

hugovk reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Feb 6, 2023

Copy link
Copy Markdown
Member Author

Thanks! Maybe @JulienPalard, @ezio-melotti and me?

Mariatta reacted with heart emoji
All reactions
  • ❤️ 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@pradyunsg

pradyunsg commented Feb 6, 2023

Copy link
Copy Markdown
Member

I'd be happy to be listed as well, if we don't have enough people. :)

Mariatta and hugovk reacted with heart emoji
All reactions
  • ❤️ 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Mariatta

Mariatta commented Feb 6, 2023

Copy link
Copy Markdown
Member

I'll need your readthedocs usernames: @hugovk, @pradyunsg, @JulienPalard, @ezio-melotti

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@pradyunsg

pradyunsg commented Feb 6, 2023

Copy link
Copy Markdown
Member

I'm pradyunsg (perhaps, unsurprisingly).

Mariatta reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Feb 6, 2023

Copy link
Copy Markdown
Member Author

I'm hugovk (perhaps, unsurprisingly).

Mariatta reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Mariatta

Mariatta commented Feb 6, 2023

Copy link
Copy Markdown
Member

Invites sent.

hugovk reacted with rocket emoji
All reactions
  • 🚀 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

hugovk added 3 commits February 7, 2023 18:28
@hugovk
Makefile suggestions
be22407
@hugovk
Build CPython docs with this theme on Read the Docs
d3834da
@hugovk
Add 'make htmlview' and be consistent with our other Makefiles
9a3e988
@hugovk
hugovk force-pushed the rtd-preview branch from 857d4ff to 9a3e988 Compare February 7, 2023 16:53
@hugovk

hugovk commented Feb 7, 2023

Copy link
Copy Markdown
Member Author

I'll close this and re-open it as a new PR, and hopefully it will trigger an RTD build 🤞

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk hugovk closed this Feb 7, 2023
@hugovk hugovk mentioned this pull request Feb 7, 2023
Previews in pull requests #107
Closed
@hugovk

hugovk commented Feb 7, 2023

Copy link
Copy Markdown
Member Author

Nope, didn't trigger for #107, re-opening this.

It worked on my fork, I'll compare settings:

  • Previews in pull requests hugovk/python-docs-theme#1
  • https://readthedocs.org/dashboard/hugovk-python-docs-theme/webhooks/
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk hugovk reopened this Feb 7, 2023
@hugovk

hugovk commented Feb 7, 2023

Copy link
Copy Markdown
Member Author

OK, so the incoming GitHub webhook is good on my fork (at https://readthedocs.org/dashboard/hugovk-python-docs-theme/integrations/225260/):

Details image

And I also see a webhook (at https://github.com/hugovk/python-docs-theme/settings/hooks):

Details image

But not for this repo (at https://readthedocs.org/dashboard/python-docs-theme-previews/integrations/225787/):

Details image

If I click "Resync webhook" I get "Webhook activation failed. Make sure you have the necessary permissions", which makes sense as I don't have admin permissions here.


@Mariatta Please can you try the "Resync webhook" button at https://readthedocs.org/dashboard/python-docs-theme-previews/integrations/225787/?

And is there anything at https://github.com/python/python-docs-theme/settings/hooks?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk

hugovk commented Feb 7, 2023

Copy link
Copy Markdown
Member Author

Łukasz has enabled we hooks. 🎣

Close/re-open to retrigger...

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hugovk hugovk closed this Feb 7, 2023
@hugovk hugovk reopened this Feb 7, 2023
@hugovk
hugovk marked this pull request as ready for review February 7, 2023 21:37
@hugovk

hugovk commented Feb 7, 2023

Copy link
Copy Markdown
Member Author

Deploy preview is now built!

Ready for review!

https://python-docs-theme-previews--105.org.readthedocs.build/en/105/

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

pradyunsg
pradyunsg approved these changes Feb 13, 2023
View reviewed changes
@pradyunsg
pradyunsg merged commit 506e0f2 into python:main Feb 13, 2023
@hugovk
hugovk deleted the rtd-preview branch February 13, 2023 11:04
@hugovk hugovk mentioned this pull request Feb 13, 2023
Reduce footer margin only for desktop #106
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pradyunsg pradyunsg pradyunsg approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Previews in pull requests

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@hugovk @JDLH @Mariatta @pradyunsg
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.