Skip to content

New docs site doesn't contain objects.inv #10814

Description

@ashb

The newly published docs site for the python libraries does not contain the objects.inv anymore which makes it hard nicely link to it form downstream projects.

For example, https://googleapis.dev/python/storage/latest/objects.inv used to exist, but that now 301s to https://cloud.google.com/python/docs/reference/storage/latest/index.html and I wasn't able to guess at a working URL on that cloud.google.com/python/docs/ site that has an objects.inv?

Is this file available anymore? Can it be brought back if it is not currently?

Activity

  1. added
    type: docsImprovement to the documentation for an API.
    on Jan 10, 2023
  2. parthea commented on Jan 10, 2023

    @parthea
    Contributor

    Hi @ashb ! Thanks for reporting this issue! We're looking into it.

  3. added
    status: investigatingThe issue is under investigation, which is determined to be non-trivial.
    on Jan 10, 2023
  4. dandhlee commented on Jan 10, 2023

    @dandhlee
    Contributor

    Hey @ashb, thanks for opening this issue.

    I'm not too familiar with how this works for when it 301's - are there any issues you're running into? Or do you simply just want to know if there's a direct link you can use for cloud.google.com/ equivalent for the googleapis.dev/ links?

    I might not be able to get to having objects.inv files on cloud.google.com directories, so if you can let me know as much info as possible (issues you're running into, if you're blocked, if there's no alternatives) please let me know as you won't be the only one getting affected by this.

  5. ashb commented on Jan 10, 2023

    @ashb
    Author

    The issue is specifically that objects.inv (a binary file created as part of the sphinx build process) is not available anywhere.

    This file let's us link to a class in these libraries from the Airflow docs by name, without having to know the exact URL or worry if it moves slightly version to version, or if the page it is documented on changes.

  6. dandhlee commented on Jan 10, 2023

    @dandhlee
    Contributor

    Ah, I see what the problem is.

    If we get https://googleapis.dev/python/storage/latest/objects.inv to be available again, would that work even though we'll be redirecting the content for googleapis.dev/python/$package/latest to cloud.google.com/python/docs/reference/$package/latest? Or do you need objects.inv to be available for the local reference for this to work?

  7. csm10495 commented on Jan 10, 2023

    @csm10495

    I think it can 301 as long as it 301s to the actual inv file again. (The problem now is it 301s to a generic docs page instead of the actual inv file). The inv file is used by the sphinx build process of airflow to properly link to google cloud docs

  8. dandhlee commented on Jan 10, 2023

    @dandhlee
    Contributor

    Thank you! I'll try and work on having googleapis.dev/python/$package/latest/objects.inv files be available ASAP. I'll update once that's done.

    As per cloud.google.com/python/docs/reference/$package/latest/objecs.inv - that will take some more time. I might try and redirect them to the googleapis.dev one in the meantime, but I'll try to figure out a more permanent solution that makes sense.

  9. added
    priority: p1Important issue which blocks shipping the next release. Will be fixed prior to next release.
    and removed
    status: investigatingThe issue is under investigation, which is determined to be non-trivial.
    on Jan 10, 2023
  10. ashb commented on Jan 10, 2023

    @ashb
    Author

    Having the 301 be right would be nice, but having it available anywhere is good enough to fix our CI pipeline

  11. potiuk commented on Jan 10, 2023

    @potiuk
    Contributor

    Thank you! I'll try and work on having googleapis.dev/python/$package/latest/objects.inv files be available ASAP. I'll update once that's done.

    Keep fingers crossed.

  12. dandhlee commented on Feb 14, 2023

    @dandhlee
    Contributor

    Hi folks, sorry for the delay. While the documentation has been redirected, the original objects.inv files have been restored and will continue to exist in the original location and not near the cloud.google.com domain for now. Should things change, updates will be sent out to let you know where they can be found.

  13. 7 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

priority: p1Important issue which blocks shipping the next release. Will be fixed prior to next release.status: acknowledgedtype: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions