Revised docstrings added ver 8 release notes.

This commit is contained in:
Ahmet Bakan 2015-10-09 18:41:45 -07:00
parent a2653ce8a3
commit 0ed765d95a
3 changed files with 30 additions and 17 deletions

View file

@ -297,7 +297,7 @@ def ablog_post(filename, title=None, **kwargs):
@arg('--push-quietly', dest='push_quietly', action='store_true', default=False,
help="be more quiet when pushing changes")
@arg('-f', dest='push_force', action='store_true', default=False,
help="owerwrites last commit, as 'commit --amend' and 'push -f'")
help="owerwrite last commit, i.e. `commit --amend; push -f`")
@arg('-m', dest='message', type=str, help="commit message")
@arg('-g', dest='github_pages', type=str,
help="GitHub username for deploying to GitHub pages")

View file

@ -125,24 +125,23 @@ Running ``ablog deploy`` will push your website to GitHub.
::
ablog deploy -h
usage: ablog deploy [-h] [-w WEBSITE] [-g GITHUB_PAGES] [-m MESSAGE] [-f]
[--push-quietly] [--github-token GITHUB_TOKEN]
$ ablog deploy -h
usage: ablog deploy [-h] [-w WEBSITE] [-g GITHUB_PAGES] [-m MESSAGE] [-f]
[--push-quietly] [--github-token GITHUB_TOKEN]
Path options can be set in conf.py. Default values of paths are relative to
conf.py.
Path options can be set in conf.py. Default values of paths are relative to
conf.py.
optional arguments:
-h, --help show this help message and exit
-w WEBSITE path for website, default is _website when
`ablog_website` is not set in conf.py
-g GITHUB_PAGES GitHub username for deploying to GitHub pages
-m MESSAGE commit message
-f owerwrites last commit, as 'commit --amend' and 'push
-f'
--push-quietly be more quiet when pushing changes
--github-token GITHUB_TOKEN
environment variable name storing GitHub access token
optional arguments:
-h, --help show this help message and exit
-w WEBSITE path for website, default is _website when
`ablog_website` is not set in conf.py
-g GITHUB_PAGES GitHub username for deploying to GitHub pages
-m MESSAGE commit message
-f owerwrite last commit, i.e. `commit --amend; push -f`
--push-quietly be more quiet when pushing changes
--github-token GITHUB_TOKEN
environment variable name storing GitHub access token
Create a Post
-------------

View file

@ -0,0 +1,14 @@
ABlog v0.8 released
===================
.. post:: Oct 15, 2015
:author: Ahmet
:category: Release
:location: SF
ABlog v0.8.0 is released
* Added ``-a`` argument to :ref:`ablog build <build>` command.
* Added ``-f`` argument to :ref:`ablog deploy <deploy>` command.