From 0ed765d95a23ad7dce48c755773ac60dd08cf319 Mon Sep 17 00:00:00 2001 From: Ahmet Bakan Date: Fri, 9 Oct 2015 18:41:45 -0700 Subject: [PATCH] Revised docstrings added ver 8 release notes. --- ablog/commands.py | 2 +- docs/manual/ablog-commands.rst | 31 ++++++++++++++-------------- docs/release/ablog-v0.8-released.rst | 14 +++++++++++++ 3 files changed, 30 insertions(+), 17 deletions(-) create mode 100644 docs/release/ablog-v0.8-released.rst diff --git a/ablog/commands.py b/ablog/commands.py index 079ebbd..cfad6a7 100644 --- a/ablog/commands.py +++ b/ablog/commands.py @@ -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") diff --git a/docs/manual/ablog-commands.rst b/docs/manual/ablog-commands.rst index 7f884ec..cd1a26d 100644 --- a/docs/manual/ablog-commands.rst +++ b/docs/manual/ablog-commands.rst @@ -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 ------------- diff --git a/docs/release/ablog-v0.8-released.rst b/docs/release/ablog-v0.8-released.rst new file mode 100644 index 0000000..680c4f3 --- /dev/null +++ b/docs/release/ablog-v0.8-released.rst @@ -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 ` command. + + * Added ``-f`` argument to :ref:`ablog deploy ` command.