From 5d67ad5d45390bacaf9397f56adb4bb1dfcc613f Mon Sep 17 00:00:00 2001 From: jose ariza Date: Tue, 6 Sep 2016 10:19:19 -0500 Subject: [PATCH 1/2] fixed documentation --- .github/ISSUE_TEMPLATE.md | 2 +- CONTRIBUTING.rst | 4 ++-- README.rst | 8 +++++--- docs/index.rst | 2 +- docs/integration.rst | 2 +- docs/usage.rst | 9 +++++---- example/templates/wordpress_api/base.html | 2 +- 7 files changed, 16 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 9ce3c08..50b71fa 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ -* Django Wordpres API version: +* Django Wordpress API version: * Django version: * Python version: * Operating System: diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index fa0f4c5..1aa4079 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -36,8 +36,8 @@ is open to whoever wants to implement it. Write Documentation ~~~~~~~~~~~~~~~~~~~ -Django Wordpres API could always use more documentation, whether as part of the -official Django Wordpres API docs, in docstrings, or even on the web in blog posts, +Django Wordpress API could always use more documentation, whether as part of the +official Django Wordpress API docs, in docstrings, or even on the web in blog posts, articles, and such. Submit Feedback diff --git a/README.rst b/README.rst index 66fc64b..f0d5042 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ ============================= -Django Wordpres API +Django Wordpress API ============================= .. image:: https://badge.fury.io/py/django-wordpress-api.png @@ -17,7 +17,9 @@ Django Wordpres API Easily Install your Wordpress blog in your Django project -This package allows to communicate easily with any wordpress proyect that is using [WP REST API v1](http://wp-api.org/index-deprecated.html). Even though the WP REST API package is already on the 2 version; it is still on beta so it was decided that this package will only support v1 until v2 is out of beta. +This package allows to communicate easily with any wordpress proyect that is using `WP REST API v1 `_ . + +Even though the WP REST API package is already on the 2 version; it is still on beta so it was decided that this package will only support v1 until v2 is out of beta. Documentation ------------- @@ -40,7 +42,7 @@ Features * Connect to an external wordpress application * Retreives all the blog posts ordered by pages -* Filter blog posts using several of the [available filters in WP REST API](http://wp-api.org/index-deprecated.html#posts_retrieve-posts) +* Filter blog posts using several of the `available filters in WP REST API `_ * Search blog posts using a keyword * order the blog posts by several attributes like author, title, type, etc; ascending and descending order (default order is descending date) * Retreive posts with a different type than "post" diff --git a/docs/index.rst b/docs/index.rst index e6452b9..60d5214 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Django Wordpres API's documentation! +Welcome to Django Wordpress API's documentation! ================================================================= Contents: diff --git a/docs/integration.rst b/docs/integration.rst index b18feaf..8ec192b 100644 --- a/docs/integration.rst +++ b/docs/integration.rst @@ -19,7 +19,7 @@ You need two settings variables to be able to use the package: WP_URL = http://your-wordpress-app.com/ BLOG_POSTS_PER_PAGE = -Remmember to add [WP REST API v1](http://wp-api.org/index-deprecated.html) to http://your-wordpress-app.com/ or this package will be useless. +Remmember to add `WP REST API v1 `_ to http://your-wordpress-app.com/ or this package will be useless. Add django-wordpress-api diff --git a/docs/usage.rst b/docs/usage.rst index 1130bd6..dfc14c7 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -2,22 +2,23 @@ Usage ======== -To use Django Wordpres API in a project:: +To use Django Wordpress API in a project:: import wordpress_api The django-wordpress-api has two main features: - the WPApiConnector and the Views that uses it. - If you want to use the pre defined views, just add wordpress-api-urls to your project. + The basic django-wordpress-api urls are:: -:: http://localhost:8000/blog/; display the blog list + http://localhost:8000/(?P[-\w]+)/; displays the detail of a blog identified with the given slug + http://localhost:8000/category/(?P[-\w]+)/; displays the blogs in the category identified with the given slug + http://localhost:8000/tag/(?P[-\w]+)/; displays the blogs in the tag identified with the given slug Else, If you want to retreive the blog posts in your custom views, you can use directly the WPApiConnector and its methods. You can check them at wordpress_api/utils.py diff --git a/example/templates/wordpress_api/base.html b/example/templates/wordpress_api/base.html index f9be277..fd4c3ab 100644 --- a/example/templates/wordpress_api/base.html +++ b/example/templates/wordpress_api/base.html @@ -3,7 +3,7 @@ - {% block title %}Django Wordpres API{% endblock title %} + {% block title %}Django Wordpress API{% endblock title %} From b3daed74b08fed3b906073bfecc4cf4141b5247a Mon Sep 17 00:00:00 2001 From: jose ariza Date: Tue, 6 Sep 2016 10:19:57 -0500 Subject: [PATCH 2/2] updated docs --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index cbaa02b..314d535 100755 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ except ImportError: from distutils.core import setup -version = '0.1.3' +version = '0.1.4' if sys.argv[-1] == 'publish': try: