Init MKdocs

Author: Emmanouil Konstantinidis

docs/changelog.md

@@ -0,0 +1,53 @@
+---
+title:  "Changelog"
+source_filename: "changelog"
+order: 8
+---
+
+### Release 0.0.7
+
+  - Fix methods in Live API Endpoints (now compatible with Python 2.7)
+  - Remove `.<format>` from urls
+  - Fixed a bug that removes double slashes from the endpoint's url
+
+
+### Release 0.0.6
+
+  - Introducing Live API Endpoints - Test your endpoints from within the docs
+  - Setting `HIDDEN` is now `HIDE_DOCS`
+
+
+### Release 0.0.5
+
+  - Support both common types of ROOT_URLCONF
+
+
+### Release 0.0.4
+
+  - Allow templates overrides
+  - More template `blocks` to be overridden
+  - Improved MANIFEST.in
+  - Exclude `node_modules/`
+
+
+### Release 0.0.3
+
+  - Fixes a bug where Django's `collectstatic` command was failing because of Glyphicons
+
+
+### Release 0.0.2
+
+  - Search between endpoint paths
+  - Display docstring for each endpoint
+
+
+### Release 0.0.1
+
+First release of the project to [pypi](https://pypi.python.org/pypi). Features include:
+
+ - List all endpoints that inherit from DRF's `APIView`
+ - Settings to hide docs view (ie. in Production)
+ - Override Templates
+ - Support for Python 2.7, 3.3, 3.4, 3.5
+ - Support for Django 1.8, 1.9
+ - Support for Django REST Framework 3 and above

docs/contributing.md

@@ -0,0 +1,100 @@
+---
+title:  "Contributing & Development"
+source_filename: "contributing"
+order: 7
+---
+
+### Development
+If you want to **use the demo** app to work on this package:
+
+In the project [repository](https://github.com/ekonstantinidis/django-rest-framework-docs) you can find the demo app(at /demo). It is a project with Django & Django Rest Framework that will allow you to work with this project.
+
+From the root of the repository:
+
+    # Create the virtual environment
+    pyvenv env
+
+    # Install requirements
+    env/bin/pip install -r requirements.txt
+
+    # Activate the environment
+    source env/bin/activate
+
+    # Cd Into the demo
+    cd demo/
+
+    # Install Django Rest Framework Docs
+    pip install -e ../
+
+    # Run the project
+    python manage.py runserver
+
+Note: You do not need a database or to run migrate.
+
+
+If you are looking to develop this package with one of your **own django projects**:
+
+    pyvenv env
+    env/bin/pip install -r requirements.txt
+    pip install -e ~/Projects/drf-docs/
+
+### Contributing to the project
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request
+6. Make sure tests are passing
+
+
+### Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at manos@iamemmanouil.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

docs/images/django-logo.png

@@ -0,0 +1,23 @@
+---
+title:  "Home"
+permalink: /
+order: 1
+---
+
+Django REST Framework Docs (DRF Docs) allows you to list all your API Endpoints that inherit from <a href="http://www.django-rest-framework.org/" target="_blank">Django REST Framework</a> **automatically**. Its purpose is to work out of the box and it should take a minimum to install it.
+
+<a class="btn btn-success btn-demo" href="http://demo.drfdocs.com/" target="_blank"><i class="fa fa-laptop"></i> Visit the Demo</a>
+
+
+#### Live API Endpoints
+
+A really useful feature of DRF Docs is that you can also test endpoints from within the docs. Feel free to use our demo and try them! For more information visit the [Live API Endpoints](/docs/live-api) page of the docs.
+
+<img class="img-responsive" src="images/mockup.png" alt="Mock Up" />
+
+
+#### How It Works
+
+The concept is pretty simple. Once you [install it](/docs/installation/) you should go the the url you set (ie. `http://0.0.0.0:8000/docs/`) and you should see all your API endpoints along with the serializer fields, allowed methods etc for each one.
+
+DRF Docs will then read all your `urls` and will list those that inherit from Django REST Framework's `APIView`.

docs/images/docs.png

@@ -0,0 +1,27 @@
+---
+title:  "Installation"
+source_filename: "installation"
+order: 2
+---
+
+The installation itself should not take more than a couple of minutes. Follow the simple steps below.
+
+Install using pip:
+
+    pip install drfdocs
+
+Add 'rest_framework_docs' to your `INSTALLED_APPS` setting:
+
+    INSTALLED_APPS = (
+        ...
+        'rest_framework_docs',
+    )
+
+Finally include the `rest_framework_docs` urls in your `urls.py`:
+
+    urlpatterns = [
+        ...
+        url(r'^docs/', include('rest_framework_docs.urls')),
+    ]
+
+You can now visit [http://0.0.0.0:/8000/docs/](http://0.0.0.0:/8000/docs/) to view your Web API's docs.

docs/images/drf-logo.png

@@ -0,0 +1,14 @@
+---
+title:  "Live API Endpoints"
+source_filename: "live-api"
+order: 5
+---
+
+### What is "Live API Endpoints"?
+Live API Endpoints allow you to test your endpoints from within DRF docs. For each endpoints you can press the little *plug* icon which will bring up a modal with all the endpoint's fields and all the relevant information so that you can make a request instantly.
+
+It is still in **beta** so if you face any problems - feel free to open an issue/pull request on GitHub.
+
+<img class="img-responsive" src="images/live-api.png" alt="Live API Endpoints" />
+
+The Live API is made with **[React](https://facebook.github.io/react/)**. For more information on how to hack on them, check the README of the repository.