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.

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

Intersphinx tests #23

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

norareidy
Copy link
Collaborator

@norareidy norareidy commented Feb 10, 2025

Pull Request Info

PR Reviewing Guidelines

Staging Links

  • temp-intersphinx
  • Self-Review Checklist

    • Is this free of any warnings or errors in the RST?
    • Did you run a spell-check?
    • Did you run a grammar-check?
    • Are all the links working?
    • Are the facets and meta keywords accurate?

    Copy link

    netlify bot commented Feb 10, 2025

    Deploy Preview for docs-django ready!

    Name Link
    🔨 Latest commit 5720651
    🔍 Latest deploy log https://app.netlify.com/sites/docs-django/deploys/67ab72fba556f8000898be10
    😎 Deploy Preview https://deploy-preview-23--docs-django.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Copy link
    Collaborator

    @timgraham timgraham left a comment

    Choose a reason for hiding this comment

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

    How can we build the docs locally or at least see the logs to debug this?

    I noticed something strange in this project's internal links. :ref:`django-crud`: generates a link to https://deploy-preview-23--docs-django.netlify.app/interact-data/crud/#std-label-django-crud

    The "std-label-" prefix isn't something I've seen before. If somebody can explain where that comes from, it might lead to some insight.

    Attribute
    ---------

    1. :py:attr:`Constraints <~django.db.models.Options.constraints>`
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Putting a tilde within < > is nonsense. The tilde is only meant to display the last part of the path when you don't have any brackets in the content.

    Django-admin
    ------------

    1. :std:django-admin:`<createsuperuser>`
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    django-admin and fieldlookup are Django-specific directives and won't work without some customization: https://github.com/mongodb-labs/django-mongodb-backend/blob/eb26848abd680bfdbd744452d06562f071ed06a5/docs/source/_ext/djangodocs.py

    Field lookup
    ------------

    1. :std:fieldlookup:`arrayfield.overlap`
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    fieldlookup is the directive name, e.g. source/fields.rst:.. fieldlookup:: arrayfield.contains
    lookup is the role name. (see djangodocs.py)
    The role name is what is used for links.

    @norareidy
    Copy link
    Collaborator Author

    How can we build the docs locally or at least see the logs to debug this?

    I noticed something strange in this project's internal links. :ref:`django-crud`: generates a link to https://deploy-preview-23--docs-django.netlify.app/interact-data/crud/#std-label-django-crud

    The "std-label-" prefix isn't something I've seen before. If somebody can explain where that comes from, it might lead to some insight.

    Unfortunately there's no way to build the docs locally, but you can see the full build log in the Netlify comment left on each PR: https://app.netlify.com/sites/docs-django/deploys/67aa7034603963000853ab31.
    When we link to those page targets created with the .. _label-name syntax (you can see the CRUD one at the top of the file), the link is always prefixed with std-label. Why, I'm not sure - that's something Docs Platform would know more about, who I've filed the ticket with. This powerpoint has some more info on how we use rST. The "Evolution of Tools" section is outdated since our switch to Netlify but the information on rST components/syntax might be useful.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants