Merge pull request #231 from cfpb/ditch-swagger-docs

Remove outdated swagger-docs code and files

Author: higs4281

README.md

@@ -73,27 +73,7 @@ python manage.py runserver
 
 ## API Docs
 
-[Documentation](https://cfpb.github.io/ccdb5-api/) for this repository is rendered via GitHub pages and [Swagger](https://swagger.io/docs/). They can be edited in the `docs/` directory, but to build or deploy them, you'll need to install docs requirements:
-
-```
-pip install -r docs_requirements.txt
-```
-
-You can then preview your changes locally by running `mkdocs serve` and then reviewing <http://127.0.0.1:8000/>
-
-When your changes are ready, you can submit them as a normal pull request. After that, you can use this command to publish them:
-
-```
-mkdocs gh-deploy --clean
-```
-
-That pushes the necessary files to the `gh-pages` branch.
-
-### Notes
-
-- The `mkdocs gh-deploy` command will push any edits you've made locally to the `gh-pages` branch of the repository, whether you've committed them or not.
-- Mkdocs will create a "site" directory locally when you use either `build`, `serve` or `gh-deploy`. This is used to assemble assets to be pushed to the gh-pages branch, but the `site/` directory itself doesn't need to be under version control. It can be deleted after a deploy.
-
+Original API documentation is available at https://cfpb.github.io/ccdb5-api/, but the docs are not being updated at this time.
 
 ##  Running Tests
 

ccdb5_api/settings.py

@@ -22,7 +22,6 @@
     "django.contrib.staticfiles",
     "rest_framework",
     "complaint_search",
-    "rest_framework_swagger",
     "flags",
 )
 
@@ -60,20 +59,6 @@
 
 WSGI_APPLICATION = "ccdb5_api.wsgi.application"
 
-SWAGGER_SETTINGS = {
-    "api_path": "/",
-    "api_version": "0.1",
-    "info": {
-        "title": "Complaint Search Public API",
-        "description": "This is the API for looking at Complaint Search Data",
-        "version": "1.0.0",
-        "termsOfService": "http://swagger.io/terms/",
-        "contact": "[email protected]",
-        "license": "Apache 2.0",
-        "licenseUrl": "http://www.apache.org/licenses/LICENSE-2.0.html",
-    },
-}
-
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",