Merge pull request #68 from ekonstantinidis/move-docs-mkdocs

Init MKdocs

Author: ekonstantinidis

.gitignore

@@ -9,5 +9,7 @@ demo/db.sqlite3
 dist/
 drfdocs.egg-info/
 
+site/
+
 rest_framework_docs/static/node_modules/
 rest_framework_docs/static/rest_framework_docs/js/dist.min.js.map

MANIFEST.in

@@ -6,6 +6,7 @@ global-exclude __pycache__
 global-exclude *.py[co]
 global-exclude package.json
 
+prune docs
 prune rest_framework_docs/static/node_modules
 
 graft rest_framework_docs/static/rest_framework_docs

docs/CNAME

@@ -0,0 +1 @@
+drfdocs.com

docs/changelog.md

@@ -0,0 +1,52 @@
+---
+title:  "Changelog"
+source_filename: "changelog"
+---
+
+### 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,98 @@
+---
+source_filename: contributing
+---
+
+### 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 [email protected]. 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/css/styles.css

@@ -0,0 +1,144 @@
+/* @group Misc */
+
+body {
+  background-color: #FEFEFE;
+}
+
+.btn-demo {
+  display: block;
+  margin: 20px auto 10px;
+  max-width: 180px;
+}
+
+.btn-edit {
+  margin-top: 10px;
+  padding: 5px 10px;
+  float: right;
+}
+
+.side-nav {
+  margin-top: 0;
+}
+
+/* @end Misc */
+
+
+/* @group Header */
+
+.header .jumbotron {
+  margin: 30px 0 40px;
+  padding: 10px 20px 20px;
+  text-align: center;
+}
+
+.header .jumbotron .img-responsive {
+  display: inline-block;
+  margin: 5px auto;
+}
+
+.header .jumbotron .logo-badge {
+  max-width: 150px;
+}
+
+/* @end Header */
+
+
+/* @group Content Page */
+
+.page .page-title {
+  margin-top: 0;
+}
+
+/* @end Content Page */
+
+
+/* @group Footer */
+
+.footer {
+  text-align: center;
+  padding: 20px;
+  margin-bottom: 20px;
+}
+
+.footer .links {
+  padding: 20px 0;
+}
+
+.footer .links .fa {
+  margin: 0 10px;
+  font-size: 22px;
+}
+
+/* @end Footer */
+
+
+/* @group Scroll to Top */
+
+.scroll-to-top {
+  padding: 10px;
+  background-color: #ecf0f1;
+  color: #18bc9c;
+  font-size: 12px;
+  text-decoration: none;
+
+  position: fixed;
+  bottom: 40px;
+  right: 40px;
+  display:none;
+
+  -webkit-border-radius: 5px;
+  -moz-border-radius:    5px;
+  border-radius:         5px;
+  -moz-background-clip:    padding;
+  -webkit-background-clip: padding-box;
+  background-clip:         padding-box;
+}
+
+.scroll-to-top:hover {
+  text-decoration: none;
+}
+
+/* @end Scroll to Top */
+
+
+
+/* @group Github Ribbon - SVG */
+
+.github-corner:hover .octo-arm {
+  animation: octocat-wave 560ms ease-in-out;
+}
+
+@keyframes octocat-wave {
+  0% {
+    transform: rotate(0deg);
+  }
+  20% {
+    transform: rotate(-25deg);
+  }
+  40% {
+    transform: rotate(10deg);
+  }
+  60% {
+    transform: rotate(-25deg);
+  }
+  80% {
+    transform: rotate(10deg);
+  }
+  100% {
+    transform: rotate(0deg);
+  }
+}
+
+@media (max-width: 768px) {
+  .github-corner {
+    display: none;
+  }
+  .github-corner:hover .octo-arm {
+    animation: none;
+  }
+  .github-corner .octo-arm {
+    animation: octocat-wave 560ms ease-in-out;
+  }
+}
+
+/* @end Github Ribbon - SVG */