Skip to content

Intersphinx tests #23

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

Closed
wants to merge 9 commits into from
Closed
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions source/temp-intersphinx.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
======================
Test Intersphinx Links
======================

This page is for testing purposes only and includes
the Django refs that do not work.

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.

#. :py:attr:`Constraints <django.db.models.Options.constraints>`
#. :py:attribute:`Constraints <~django.db.models.Options.constraints>`
#. :py:attribute:`Constraints <django.db.models.Options.constraints>`
#. :attribute:`Constraints <django.db.models.Options.constraints>`
#. :attr:`Constraints <django.db.models.Options.constraints>`
#. :py:attr:`Constraints <django.db.models.Options.constraints>`
#. :attr:`~django.db.models.Options.constraints`
#. :py:attr:`~django.db.models.Options.constraints`

Data
----

1. :py:data:`~django.conf.urls.handler400`
#. :py:data:`<django.conf.urls.handler400>`
#. :py:data:`django.conf.urls.handler400`
#. :data:`~django.conf.urls.handler400`


Exception
---------

1. :py:exception:`~django.core.exceptions.ViewDoesNotExist`
#. :py:exception:`<django.core.exceptions.ViewDoesNotExist>`
#. :py:exc:`<django.core.exceptions.ViewDoesNotExist>`
#. :py:exc:`~django.core.exceptions.ViewDoesNotExist`
#. :exc:`~django.core.exceptions.ViewDoesNotExist`
#. :py:exc:`ViewDoesNotExist <django.core.exceptions.ViewDoesNotExist>`

Function
--------

1. :py:function:`~django.db.models.SET`
#. :py:func:`~django.db.models.SET`
#. :func:`~django.db.models.SET`
#. :py:func:`<django.db.models.SET>`
#. :func:`~django:django.db.models.SET`

Module
------

1. :py:module:`Fields <~django.db.models.fields>`
#. :py:mod:`Fields <~django.db.models.fields>`
#. :py:mod:`Fields <~module-django.db.models.fields>`
#. :py:mod:`Fields <module-django.db.models.fields>`
#. :py:module:`Fields <module-django.db.models.fields>`
#. :mod:`Fields <~django.db.models.fields>`
#. :mod:`Fields <~module-django.db.models.fields>`
#. :py:mod:`Fields <django.db.models.fields>`

Doc
---

1. :doc:`Django's LOGGING setting <django:topics/logging>`
#. :py:doc:`Django's LOGGING setting <django:topics/logging>`
#. :std:doc:`Django's LOGGING setting <django:topics/logging>`
#. :std:doc:`Django's LOGGING setting <~django:topics/logging>`
#. :std:doc:`Django's LOGGING setting <topics/logging>`
#. :std:doc:`Django's LOGGING setting <~topics/logging>`
#. :doc:`Django's LOGGING setting <topics/logging>`

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

#. :std:django-admin:`~createsuperuser`
#. :django-admin:`~createsuperuser`
#. :djadmin:`inspectdb`
#. :py:djadmin:`inspectdb`

Command option
--------------

1. :std:cmdoption:`--skip-checks`
#. :std:cmdoption:`<--skip-checks>`
#. :std:cmdoption:`~--skip-checks`
#. :cmdoption:`--skip-checks`
#. :option:`migrate --fake-initial`
#. :py:option:`migrate --fake-initial`

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.

#. :std:fieldlookup:`~arrayfield.overlap`
#. :std:fieldlookup:`django:arrayfield.overlap`
#. :std:fieldlookup:`Overlap <arrayfield.overlap>`
#. :fieldlookup:`arrayfield.overlap`
#. :py:fieldlookup:`arrayfield.overlap`
Loading