Skip to content

Commit 4729b87

Browse files
committed
Better Index page
1 parent b37845e commit 4729b87

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
Buidling APIs with Django, DRF, Apiary, CircleCI, Heroku and more
1+
Building APIs with Django and Django Rest Framework
22
==================================================================
33

44
[Read it online](http://books.agiliq.com/projects/django-api-polls-tutorial/)
55

66
An opinionated guide to building APIs with modern tools.
7-
A retelling of Django tutorial with microservices and documentation driven development.
7+
8+
89

910
Dramatis personæ
1011
================
1112

1213
* Python: A programming language
1314
* Django: A framework for Python
1415
* Django rest framework: A flexible toolkit for building APIs
15-
* Apiary: Your api is only as good as its documentation
1616
* CircleCI: Keeps your documentation and API in sync
1717

1818

docs/index.rst

+17-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
1-
Building a Django polls API with DRF
1+
Building APIs with Django and Django Rest Framework
22
======================================================
33

4-
Contents:
4+
Building APIs with Django and DRF takes over where the Django tutorials stop.
5+
In the Django tutorials, you built a regular Django polls app. We will rebuild an API for a similar app.
6+
7+
In the chapters to come, we will build a REST(ish) api with authorization, rate limiting, first with pure Django and then with DRF.
8+
We will cover testing, contious integration, documentation tools and API collaboration tools.
9+
10+
Chapters:
511

612
.. toctree::
713
:maxdepth: 2
@@ -11,15 +17,20 @@ Contents:
1117
chapter2
1218
chapter3
1319
chapter4
14-
chapter5
15-
chapter6
16-
Documenting-API-with-RAML
1720

1821

1922

20-
Indices and tables
23+
Appendix
2124
==================
2225

26+
.. toctree::
27+
:maxdepth: 2
28+
29+
postman
30+
swagger
31+
Documenting-API-with-RAML
32+
33+
2334
* :ref:`genindex`
2435
* :ref:`modindex`
2536
* :ref:`search`

0 commit comments

Comments
 (0)