Prepare release 1.0.4

docs/changelog.rst

@@ -3,6 +3,14 @@ Changelog
 #########
 
 
+*********
+**1.0.4**
+*********
+
+- **FIX:** fixed improper generation of YAML references
+- **FEATURE:** added ``query_serializer`` parameter to
+  :func:`@swagger_auto_schema <.swagger_auto_schema>` (:issue:`16`, :pr:`17`)
+
 *********
 **1.0.3**
 *********

docs/conf.py

@@ -196,7 +196,11 @@ nitpick_ignore = [
     ('py:obj', 'APIView'),
 ]
 
+# even though the package should be already installed, the sphinx build on RTD
+# for some reason needs the sources dir to be in the path in order for viewcode to work
 sys.path.insert(0, os.path.abspath('../src'))
+
+# activate the Django testproj to be able to succesfully import drf_yasg
 sys.path.insert(0, os.path.abspath('../testproj'))
 os.putenv('DJANGO_SETTINGS_MODULE', 'testproj.settings')
 
@@ -204,11 +208,13 @@ from django.conf import settings  # noqa: E402
 
 settings.configure()
 
+# instantiate a SchemaView in the views module to make it available to autodoc
 import drf_yasg.views  # noqa: E402
 
-# instantiate a SchemaView in the views module to make it available to autodoc
 drf_yasg.views.SchemaView = drf_yasg.views.get_schema_view(None)
 
+# custom interpreted role for linking to GitHub issues and pull requests
+# use as :issue:`14` or :pr:`17`
 gh_issue_uri = "https://github.com/axnsan12/drf-yasg/issues/%d"
 gh_pr_uri = "https://github.com/axnsan12/drf-yasg/pull/%d"