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 — Increase the build frequency of English HTML stable (and pre-release?) documentation · Issue #163 · python/docsbuild-scripts

Increase the build frequency of English HTML stable (and pre-release?) documentation #163

New issue
Copy link
New issue
Copy link
Closed
Closed
Increase the build frequency of English HTML stable (and pre-release?) documentation#163
Copy link

Description

@AA-Turner
AA-Turner
opened on Sep 29, 2023
Issue body actions

It's come up a few times that increasing the frequency of builds for /3/ would be useful for core developers and contributors (potentially also /dev/ and the pre-release versions, but I'm happy to start small).

I'm led to believe that the expensive bit of the builds is the large matrix of versions and languages and the and the ePUB, PDF, etc, formats, so I wondered if it would be possible to configure a distinct task to regenerate only the English HTML documentation every e.g. 4 or 6 hours?

I believe that the config for this is located at https://github.com/python/psf-salt/blob/main/salt/docs/init.sls, though I'm not sure.

cc: @JulienPalard @hugovk @ezio-melotti for thoughts and comments

A

P.S.: I've tried a few times in the past to find out where the documentation build logs are, or at least to find out when the last rebuild was, without much success. The PSF-Salt docs have some information, and the docs themselves have a last built date (sans time) -- if anyone could point me in the right direction, I'd be very grateful!

Reacted by Hugo van Kemenade and Blaise Pabon

Activity

  1. hugovk commented on Sep 29, 2023

    @hugovk
    hugovk
    on Sep 29, 2023
    Member
    More actions

    I'm supportive.

    Once a day feels too infrequent for the English HTML docs, I'd like to see them built more frequently, maybe even triggering a deploy from merge.

    But if on cron, perhaps we could do hourly, or every 15 minutes.

    The download artifacts and translations could remain on a daily schedule.

    P.S.: I've tried a few times in the past to find out where the documentation build logs are, or at least to find out when the last rebuild was, without much success. The PSF-Salt docs have some information, and the docs themselves have a last built date (sans time) -- if anyone could point me in the right direction, I'd be very grateful!

    I think it requires ssh access to the server?

    It would be good to know the build times for various builds, and see the logs.

    the docs themselves have a last built date (sans time)

    Adding the time would be a helpful addition.

    Reacted by Adam Turner
  2. AA-Turner commented on Sep 29, 2023

    @AA-Turner
    AA-Turner
    on Sep 29, 2023
    MemberAuthor
    More actions

    Adding the time would be a helpful addition.

    This at least is a quick fix: python/cpython#110091

    A

  3. JulienPalard commented on Sep 29, 2023

    @JulienPalard
    JulienPalard
    on Sep 29, 2023
    Member
    More actions

    It was the case previously: python/psf-salt@38ee687

    But building without PDF artifacts leads, at least on version bumps, to a few hours with HTML but without PDF.

    This lead to spam on docs@ with people complaining about the absence of PDF (looks like they're used!).

    See also: python/psf-salt@38ee687

    See also: 1a0ad2e

  4. AA-Turner commented on Sep 29, 2023

    @AA-Turner
    AA-Turner
    on Sep 29, 2023
    MemberAuthor
    More actions

    a few hours with HTML but without PDF.

    Is it possible to not delete the PDFs (ie save them and only refresh every 24h?)

  5. JulienPalard commented on Oct 2, 2023

    @JulienPalard
    JulienPalard
    on Oct 2, 2023
    Member
    More actions

    The problem is not about deleting PDFs, it's about them not being created at all during releases bumps.

    It happen on every release (yearly major, but also each minor releases).

    The PDF files has names like: https://docs.python.org/3.11/archives/python-3.11.5-docs-pdf-letter.zip

    so when bumping from 3.11.5 to 3.11.6 if we only build HTML we're generating an HTML link to a non-existent PDF file.

    I tried to mitigate this by displaying a nice 404 page, see:

    https://docs.python.org/3.11/archives/python-3.11.999-docs-pdf-letter.zip

    but it still lead to frustrated users and complains.

  6. encukou commented on Oct 4, 2023

    @encukou
    encukou
    on Oct 4, 2023
    Member
    More actions

    Would it be possible to make the 404 page link to the corresponding directory listing, like https://docs.python.org/3.11/archives/ ?

    Reacted by Adam Turner and Hugo van Kemenade
  7. AA-Turner commented on Sep 25, 2024

    @AA-Turner
    AA-Turner
    on Sep 25, 2024
    MemberAuthor
    More actions

    xref python/docs-community#131

  8. AA-Turner commented on Oct 2, 2024

    @AA-Turner
    AA-Turner
    on Oct 2, 2024
    MemberAuthor
    More actions

    Per python/docs-community#131 (comment), this has now been done.

    A

    Reacted by Hugo van Kemenade
  9. AA-Turner
    closed this as completedon Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402520 — 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.