-
Notifications
You must be signed in to change notification settings - Fork 3
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
base: master
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for docs-django ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this 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.
source/temp-intersphinx.txt
Outdated
Attribute | ||
--------- | ||
|
||
1. :py:attr:`Constraints <~django.db.models.Options.constraints>` |
There was a problem hiding this comment.
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.
source/temp-intersphinx.txt
Outdated
Django-admin | ||
------------ | ||
|
||
1. :std:django-admin:`<createsuperuser>` |
There was a problem hiding this comment.
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
source/temp-intersphinx.txt
Outdated
Field lookup | ||
------------ | ||
|
||
1. :std:fieldlookup:`arrayfield.overlap` |
There was a problem hiding this comment.
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.
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. |
Pull Request Info
PR Reviewing Guidelines
Staging Links
Self-Review Checklist