Commits

Stefan Scherfke  committed 722cecd

Updated docstrings.

  • Participants
  • Parent commits 6b11617

Comments (0)

Files changed (5)

File sphinxdoc/admin.py

 
 
 class ProjectAdmin(admin.ModelAdmin):
-    """Admin interface for :class:`sphinx.models.Project`."""
+    """Admin interface for :class:`~sphinxdoc.models.Project`."""
     list_display = ('name', 'path',)
     prepopulated_fields = {'slug': ('name',)}
     
 
 class DocumentAdmin(admin.ModelAdmin):
     """
-    Admin interface for :class:`sphinx.models.Document`.
+    Admin interface for :class:`~sphinxdoc.models.Document`.
     
     Normally, you shouldn’t need this, since you create new documents via
     the management command.

File sphinxdoc/forms.py

     Custom search form for Haystack.
     
     It narrows the search query set to instances of 
-    :class:`sphinxdoc.models.Document` that belong to the current
-    :class:`sphinxdoc.models.Project`.
+    :class:`~sphinxdoc.models.Document` that belong to the current
+    :class:`~sphinxdoc.models.Project`.
     
     """
     def __init__(self, *args, **kwargs):

File sphinxdoc/management/commands/updatedoc.py

 # encoding: utf-8
 """
-Management command for updadng the documentation of one or more projects.
+Management command for updading the documentation of one or more projects.
 
 """
 
 EXTENSION = '.fjson'
 SPECIAL_TITLES = {
     'genindex': 'General Index',
-    'modindex': 'Module Index',
+    'py-modindex': 'Module Index',
     'search': 'Search',
 }
 
         
     def import_files(self, project):
         """
-        Creates a :class:`sphinxdoc.models.Document` instance for each JSON
+        Creates a :class:`~sphinxdoc.models.Document` instance for each JSON
         file of ``project``.
         """
         path = os.path.join(project.path, BUILDDIR, 'json')

File sphinxdoc/search_indexes.py

 
 class DocumentIndex(indexes.SearchIndex):
     """
-    Index for :class:`sphinxdoc.models.Document`.
+    Index for :class:`~sphinxdoc.models.Document`.
     
     """
     text = indexes.CharField(document=True, use_template=True)

File sphinxdoc/views.py

 
 class ProjectSearchView(SearchView):
     """
-    Handles a search request and displays the results as a simple list.
+    Inherits :class:`SearchView` and handles a search request and displays the
+    results as a simple list.
     
     """
     def __init__(self):
     
     def build_form(self):
         """
-        Instantiates the form the class should use to process the search query.
+        Instantiates the form that should be used to process the search query.
         
         """        
         return self.form_class(self.request.GET, slug=self.slug,