Skip to content

Commit e0304d0

Browse files
author
Ed Costello
committed
DOCS-576 additional linking fixes
1 parent 3b1b9e9 commit e0304d0

File tree

2 files changed

+22
-19
lines changed

2 files changed

+22
-19
lines changed

conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,10 @@
9999

100100
intersphinx_mapping = {
101101
'pymongo': ('http://api.mongodb.org/python/current/', None),
102-
'python' : ('http://docs.python.org/', None)
102+
'python' : ('http://docs.python.org/', None),
103+
'django': ('https://django.readthedocs.org/en/latest/',None),
104+
'djangomongodbengine': ('http://django-mongodb.org/',None),
105+
'djangotoolbox' : ('http://djangotoolbox.readthedocs.org/en/latest/', None),
103106
}
104107

105108
# -- Options for HTML output ---------------------------------------------------

source/tutorial/write-a-tumblelog-application-with-django-mongodb-engine.txt

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ have a basic familiarity with MongoDB operation and have
2828

2929
.. note::
3030

31-
`Django MongoDB Engine`_ uses the a forked version of Django 1.3
31+
`Django MongoDB Engine`_ uses a forked version of Django 1.3
3232
that adds non-relational support.
3333

3434
.. _Django: http://www.djangoproject.com
@@ -47,7 +47,7 @@ Prerequisite
4747
This tutorial uses pip_ to install packages and virtualenv_ to isolate
4848
Python environments. While these tools and this configuration are not
4949
required as such, they ensure a standard environment and are strongly
50-
recommended. Issue the following command at the system prompt:
50+
recommended. Issue the following commands at the system prompt:
5151

5252
.. code-block:: sh
5353

@@ -59,7 +59,7 @@ Respectively, these commands: install the ``virtualenv`` program
5959
project (named ``myproject``.)
6060

6161
To activate ``myproject`` environment at the system prompt, use the
62-
following command:
62+
following commands:
6363

6464
.. code-block:: bash
6565

@@ -133,7 +133,7 @@ The first step in writing a tumblelog in `Django`_ is to define the
133133
"models" or in MongoDB's terminology :term:`documents <document>`.
134134

135135
In this application, you will define posts and comments, so that each
136-
:py:class:`Post` can contain a list of :py:class:`Comments`. Edit the
136+
``Post`` can contain a list of ``Comments``. Edit the
137137
:file:`tumblelog/models.py` file so it resembles the following:
138138

139139
.. code-block:: python
@@ -167,17 +167,17 @@ In this application, you will define posts and comments, so that each
167167
author = models.CharField(verbose_name="Name", max_length=255)
168168

169169

170-
The Django "nonrel" code looks the same as vanilla Django however,
170+
The Django "nonrel" code looks the same as vanilla Django, however
171171
there is no built in support for some of MongoDB's native data types
172-
like Lists and Embedded data. :py:mod:`djangotoolbox` handles these
172+
like Lists and Embedded data. :py:mod:`djangotoolbox:djangotoolbox` handles these
173173
definitions.
174174

175175
.. see:: The Django MongoDB Engine fields_ documentation for more.
176176

177-
The models declare an index to :py:class:`Post`. One for the
178-
:py:obj:`created_at` date as our frontpage will order by date: there
179-
is no need to add :py:obj:`db_index` on :py:obj:`SlugField` because
180-
there is a default index on :py:obj:`SlugField`.
177+
The models declare an index to the ``Post`` class. One for the
178+
``created_at`` date as our frontpage will order by date: there
179+
is no need to add ``db_index`` on ``SlugField`` because
180+
there is a default index on ``SlugField``.
181181

182182
.. _fields: http://django-mongodb.org/reference/fields.html
183183

@@ -268,7 +268,7 @@ and :file:`templates/tumblelog` for storing the tumblelog templates:
268268
mkdir -p templates/tumblelog
269269

270270
Configure Django so it can find the templates by updating
271-
:py:obj:`TEMPLATE_DIRS` in the :file:`settings.py` file to the
271+
``TEMPLATE_DIRS`` in the :file:`settings.py` file to the
272272
following:
273273

274274
.. code-block:: python
@@ -441,7 +441,7 @@ the following to the :file:`views.py` file:
441441

442442
.. note::
443443

444-
:py:class:`PostDetailView` extends the :py:class:`DetailView` so
444+
The ``PostDetailView`` class extends the ``DetailView`` class so
445445
that it can handle ``GET`` and ``POST`` requests. On ``POST``,
446446
:py:func:`post` validates the comment: if valid, :py:func:`post`
447447
appends the comment to the post.
@@ -511,19 +511,19 @@ can easily create an administrative interface for posts with
511511
Django. Enable the admin by adding the following apps to
512512
:py:obj:`INSTALLED_APPS` in :file:`settings.py`.
513513

514-
- :py:mod:`django.contrib.admin`
515-
- :py:mod:`django_mongodb_engine`
516-
- :py:mod:`djangotoolbox`
514+
- :py:mod:`django:django.contrib.admin`
515+
- :py:mod:`djangomongodbengine`
516+
- :py:mod:`djangotoolbox:djangotoolbox`
517517
- :py:mod:`tumblelog`
518518

519519
.. warning::
520520

521521
This application does not require the :py:class:`Sites`
522-
framework. As a result, remove :py:mod:`django.contrib.sites` from
522+
framework. As a result, remove :py:mod:`django:django.contrib.sites` from
523523
:py:obj:`INSTALLED_APPS`. If you need it later please read
524524
`SITE_ID issues`_ document.
525525

526-
Create a :file:`admin.py` file and register the :py:class:`Post` model
526+
Create a :file:`admin.py` file and register the ``Post`` model
527527
with the admin app:
528528

529529
.. code-block:: python
@@ -536,7 +536,7 @@ with the admin app:
536536
.. note::
537537

538538
The above modifications deviate from the default django-nonrel_ and
539-
:py:mod:`djangotoolbox` mode of operation. Django's administration
539+
:py:mod:`djangotoolbox:djangotoolbox` mode of operation. Django's administration
540540
module will not work unless you exclude the ``comments`` field. By
541541
making the ``comments`` field non-editable in the "admin" model
542542
definition, you will allow the administrative interface to function.

0 commit comments

Comments
 (0)