diff --git a/.gitignore b/.gitignore index ae73f8379..9e17827bd 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ local/ !.gitignore !.travis.yml +site/ diff --git a/docs/404.html b/docs/theme/404.html similarity index 100% rename from docs/404.html rename to docs/theme/404.html diff --git a/docs/template.html b/docs/theme/base.html similarity index 96% rename from docs/template.html rename to docs/theme/base.html index f36cffc6d..45e19cf37 100644 --- a/docs/template.html +++ b/docs/theme/base.html @@ -187,7 +187,12 @@ a.fusion-poweredby { -->
:::bash', r'', output)
- output = re.sub(r'', r'', output)
- output = re.sub(r'', code_label, output)
- open(output_path, 'w').write(output.encode('utf-8'))
-
-if preview:
- import subprocess
-
- url = 'html/index.html'
-
- try:
- subprocess.Popen(["open", url]) # Mac
- except OSError:
- subprocess.Popen(["xdg-open", url]) # Linux
- except:
- os.startfile(url) # Windows
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 000000000..0134679c4
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,55 @@
+site_name: Django REST frameowkr
+site_url: http://www.django-rest-framework.org/
+site_description: Django REST framework - Web APIs for DjangoProject documentation with Markdown.
+
+repo_url: https://github.com/tomchristie/django-rest-framework
+
+pages:
+ - ['index.md', ]
+ - ['tutorial/quickstart.md', ]
+ - ['tutorial/1-serialization.md', ]
+ - ['tutorial/2-requests-and-responses.md', ]
+ - ['tutorial/3-class-based-views.md', ]
+ - ['tutorial/4-authentication-and-permissions.md', ]
+ - ['tutorial/5-relationships-and-hyperlinked-apis.md', ]
+ - ['tutorial/6-viewsets-and-routers.md', ]
+ - ['api-guide/requests.md', ]
+ - ['api-guide/responses.md', ]
+ - ['api-guide/views.md', ]
+ - ['api-guide/generic-views.md', ]
+ - ['api-guide/viewsets.md', ]
+ - ['api-guide/routers.md', ]
+ - ['api-guide/parsers.md', ]
+ - ['api-guide/renderers.md', ]
+ - ['api-guide/serializers.md', ]
+ - ['api-guide/fields.md', ]
+ - ['api-guide/relations.md', ]
+ - ['api-guide/authentication.md', ]
+ - ['api-guide/permissions.md', ]
+ - ['api-guide/throttling.md', ]
+ - ['api-guide/filtering.md', ]
+ - ['api-guide/pagination.md', ]
+ - ['api-guide/content-negotiation.md', ]
+ - ['api-guide/format-suffixes.md', ]
+ - ['api-guide/reverse.md', ]
+ - ['api-guide/exceptions.md', ]
+ - ['api-guide/status-codes.md', ]
+ - ['api-guide/testing.md', ]
+ - ['api-guide/settings.md', ]
+ - ['topics/documenting-your-api.md', ]
+ - ['topics/ajax-csrf-cors.md', ]
+ - ['topics/browser-enhancements.md', ]
+ - ['topics/browsable-api.md', ]
+ - ['topics/rest-hypermedia-hateoas.md', ]
+ - ['topics/third-party-resources.md', ]
+ - ['topics/contributing.md', ]
+ - ['topics/rest-framework-2-announcement.md', ]
+ - ['topics/2.2-announcement.md', ]
+ - ['topics/2.3-announcement.md', ]
+ - ['topics/2.4-announcement.md', ]
+ - ['topics/release-notes.md', ]
+ - ['topics/credits.md', ]
+
+theme_dir: docs/theme
+copyright: Copyright © 2014, Tom Christie.
+google_analytics: ['UA-27795084-5', 'mkdocs.org']