Skip to content

DOCSP-48767: Intersphinx links #28

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

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

norareidy
Copy link
Collaborator

@norareidy norareidy commented Apr 7, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-48767

Staging Links

  • temp
  • connect
  • get-started/create-admin
  • interact-data/specify-a-query
  • limitations-upcoming
  • model-data/indexes
  • model-data/models
  • 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 Apr 7, 2025

    Deploy Preview for docs-django ready!

    Name Link
    🔨 Latest commit e398f4b
    🔍 Latest deploy log https://app.netlify.com/sites/docs-django/deploys/67f4562fc773500008fa2569
    😎 Deploy Preview https://deploy-preview-28--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.

    @@ -146,11 +146,11 @@ function accepts the following arguments:
    - ``db_name``: The name of the database you want to use.
    - ``conn_max_age``: Configures persistent database connections.
    This argument is optional. To learn more, see
    `Persistent connections <{+django-docs+}/ref/databases/#persistent-database-connections>`__
    :std:ext-doc:`Persistent connections <databases/#persistent-database-connections>`
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    I'd expect this syntax (if MongoDB docs team didn't implement something different):

    :ref:`Persistent connections <django:persistent-database-connections>`
    

    (You can browse https://github.com/mongodb/django-mongodb-backend/tree/main/docs/source to see some working examples.)

    Beware that the djadmin, lookup, setting roles require some custom configuration.

    @@ -13,7 +13,7 @@ Create an Admin Site

    You can create a {+framework+} admin site to edit your application's
    data from a web interface. To learn more about the {+framework+} admin
    site and its features, see `The Django admin site <{+django-docs+}/ref/contrib/admin/>`__
    site and its features, see :py:mod:`The Django admin site <django.contrib.admin>`
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    Does it work without the :py prefix? I've never needed that, and I don't think we're likely to run into collisions with other domains, but I'm not quite sure.

    <{+django-docs+}/ref/models/querysets/#field-lookups>`__ in the
    ``QuerySet`` {+framework+} API reference.
    To view a full list of lookup types, see
    :std:ext-doc:`Field lookups <ref/models/querysets/#field-lookups>`
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    You cannot use an anchor like #field-lookups like this. If you want to link to a specific section, use :ref:, otherwise if you want to link to the document, use :doc:

    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