started doc changes

.travis.yml

@@ -23,7 +23,7 @@ env:
     - LOCALE=default
     - CONDA_CHANNELS="conda-forge"
     - CONDA_DEPENDENCIES="sphinx werkzeug alabaster invoke"
-    - PIP_DEPENDENCIES="coveralls"
+    - PIP_DEPENDENCIES="sphinx-automodapi coveralls"
 
 install:
     - git clone git://github.com/astropy/ci-helpers.git
@@ -36,5 +36,5 @@ install:
 script:
     - make test
 
-#after_success:
+after_success:
-#    - coveralls
+    - coveralls

LICENSE.rst

@@ -1,6 +1,6 @@
 ABlog for blogging with Sphinx
 
-Copyright (C) 2014-2018 Ahmet Bakan
+Copyright (C) 2014-2018 Ahmet Bakan and SunPy Developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -101,8 +101,8 @@ For ABlog documentation, this converts to the following where you can find more
 
 .. only:: html
 
-   .. image:: https://secure.travis-ci.org/abakan/ablog.png?branch=devel
+   .. image:: https://secure.travis-ci.org/sunpy/ablog.png?branch=devel
-      :target: http://travis-ci.org/#!/abakan/ablog
+      :target: http://travis-ci.org/#!/sunpy/ablog
 
    .. image:: https://readthedocs.org/projects/ablog/badge/?version=latest
       :target: http://ablog.readthedocs.org/

docs/conf.py

@@ -17,6 +17,7 @@ extensions = [
     'sphinx.ext.todo',
     'sphinx.ext.ifconfig',
     'sphinx.ext.extlinks',
+    'sphinx_automodapi.automodapi',
     'alabaster',
     'ablog'
 ]
@@ -87,7 +88,7 @@ html_sidebars = {
 html_theme_path = [alabaster.get_path()]
 html_theme_options = {
     'travis_button': True,
-    'github_user': 'abakan',
+    'github_user': 'sunpy',
     'github_repo': 'ablog',
     'description': 'ABlog for blogging with Sphinx',
     'logo': 'ablog.png',
@@ -101,15 +102,15 @@ intersphinx_mapping = {
 }
 extlinks = {
     'wiki': ('http://en.wikipedia.org/wiki/%s', ''),
-    'issue': ('https://github.com/abakan/ablog/issues/%s', 'issue '),
+    'issue': ('https://github.com/sunpy/ablog/issues/%s', 'issue '),
-    'pull': ('https://github.com/abakan/ablog/pull/%s', 'pull request '),
+    'pull': ('https://github.com/sunpy/ablog/pull/%s', 'pull request '),
 }
 
 rst_epilog = '''
 .. _Sphinx: http://sphinx-doc.org/
 .. _Python: http://python.org
 .. _Disqus: http://disqus.com/
-.. _GitHub: https://github.com/abakan/ablog
+.. _GitHub: https://github.com/sunpy/ablog
 .. _PyPI: https://pypi.python.org/pypi/ablog
 .. _Read The Docs: https://readthedocs.org/
 .. _Alabaster: https://github.com/bitprophet/alabaster

docs/index.rst

@@ -110,8 +110,8 @@ can find more about configuring and using ABlog:
 
 .. only:: html
 
-   .. image:: https://secure.travis-ci.org/abakan/ablog.png?branch=devel
+   .. image:: https://secure.travis-ci.org/sunpy/ablog.png?branch=devel
-      :target: http://travis-ci.org/#!/abakan/ablog
+      :target: http://travis-ci.org/#!/sunpy/ablog
 
    .. image:: https://readthedocs.org/projects/ablog/badge/?version=latest
       :target: http://ablog.readthedocs.org/

docs/manual/api.rst

@@ -0,0 +1,12 @@
+.. api:
+
+ABlog API
+=========
+
+.. post:: Feb 17, 2018
+   :tags: api
+   :author: Nabil
+   :category: Manual
+   :location: World
+
+.. automodapi:: ablog

docs/manual/auto-github-pages-deploys.rst

@@ -33,7 +33,7 @@ signing up for Travis CI using your GitHub account:
 
 Once you login, go to :guilabel:`Accounts` page and flick the switch on for your
 source repository for GitHub pages. In the below example, **website** is the
-source repository and *abakan.github.io* contains HTML output from builds:
+source repository and *sunpy.github.io* contains HTML output from builds:
 
 .. figure:: images/TravisCI_accounts.png
    :scale: 80 %
@@ -44,7 +44,7 @@ Deploy key setup
 ----------------
 
 To have builds pushed from Travis CI to GitHub, you will need a *personal access
-token*. Go to GitHub :menuselection:`Settings --> Personal access tokens` page to 
+token*. Go to GitHub :menuselection:`Settings --> Personal access tokens` page to
 generate a new token. You need only *public repo* access checked for this purpose:
 
 .. figure:: images/GitHub_token.png
@@ -53,7 +53,7 @@ generate a new token. You need only *public repo* access checked for this purpos
 
 Then, you need to set this access token as an environment variable, e.g.
 ``DEPLOY_KEY``, under :menuselection:`Settings --> Environment Variables`.
-Keep the :guilabel:Display value in build logs` switch off. 
+Keep the :guilabel:Display value in build logs` switch off.
 
 .. figure:: images/TravisCI_settings.png
    :scale: 80 %
@@ -108,4 +108,4 @@ See :ref:`deploy-to-github-pages` and :ref:`commands` to find out more about
 deploy options.
 
 Finally, you can find out more about :file:`.travis.yml` file and customizing your built on
-Travis CI `user documentation <http://docs.travis-ci.com/user/customizing-the-build/>`_.
+Travis CI `user documentation <http://docs.travis-ci.com/user/customizing-the-build/>`_.

docs/manual/posting-and-listing.rst

@@ -151,9 +151,9 @@ A list of posts can be displayed in any page using the following directive:
         :sort:
 
    This will result in a bullet list of up to 5 posts (default is all)
-   authored by :ref:`author-ahmet` in :ref:`language-en` when he was in
+   authored by `:ref:`author-ahmet`` in `:ref:`language-en`` when he was in
-   :ref:`location-pittsburgh` and posted in :ref:`category-manual`
+   `:ref:`location-pittsburgh`` and posted in `:ref:`category-manual``
-   with tags :ref:`tag-tips`. Posts will be in ``:sort:``\ed to appear in
+   with tags `:ref:`tag-tips``. Posts will be in ``:sort:``\ed to appear in
    chronological order and listed with their ``:excerpts:``.
    Here are those posts:
 

docs/release/ablog-v0.3-released.rst

@@ -32,8 +32,8 @@ ABlog v0.3.1 released
 ABlog v0.3.1 is a minor release to fix two issues in templates:
 
   * Links to collection (archive) feeds is displayed only on collection page
-    (e.g. :ref:`category-manual`), not on a catalog page that lists posts
+    (e.g. `:ref:`category-manual``), not on a catalog page that lists posts
-    for multiple collections (e.g. :ref:`blog-categories`).
+    for multiple collections (e.g. `:ref:`blog-categories``).
 
   * Links to collection feeds is displayed only when they are generated
     (see :confval:`blog_feed_archives`). Previously, links would be generated

docs/release/ablog-v0.9-released.rst

@@ -0,0 +1,37 @@
+ABlog v0.9 released
+===================
+
+.. post:: Feb 17, 2018
+   :author: Nabil
+   :category: Release
+   :location: World
+
+
+ABlog v0.9.0 is released with the main focus being to support the latest version of Sphinx.
+
+
+  * Added ``-a`` argument to :ref:`ablog build <build>` command, with which
+    you can force rewriting all pages when rebuilding your project. Default is
+    writing only pages that have changed.
+
+  * Added ``-f`` argument to :ref:`ablog deploy <deploy>` command, with which
+    you can amend to latest commit to keep GitHub pages repository small.
+    Thanks to `uralbash`_ for this contribution.
+
+  * Added ``-p`` argument to :ref:`ablog deploy <deploy>` command, with which
+    you can specify the path to your GitHub pages repository, i.e.
+    ``username.github.io``.
+
+  * Changed :confval:`fontawesome_link_cdn` to be a string argument to enable
+    linking to desired version of `Font Awesome`_. Thanks to `Albert Mietus`_
+    for this contribution.
+
+  * Post lists font style is now controlled through CSS. Thanks to
+    `Albert Mietus`_ for this contribution as well.
+
+  * Fixed internal link resolution issue that affected atom feeds of
+    collections, i.e. feeds of posts under a category, tag, or author.
+
+.. _Font Awesome: https://fortawesome.github.io/Font-Awesome/
+.. _Albert Mietus: https://github.com/AlbertMietus
+.. _uralbash: https://github.com/uralbash

setup.py

@@ -11,6 +11,9 @@ long_description = '''
 ABlog for Sphinx
 ================
 
+Please note that is an official continuation of
+`Eric Holscher's Ablog Sphinx extension <https://github.com/abakan/ablog/>`_.
+
 A Sphinx extension that converts any documentation or personal website project
 into a full-fledged blog. See http://ablog.readthedocs.org for details.
 
@@ -49,7 +52,7 @@ setup(
         'Programming Language :: Python :: 3',
     ],
     provides=['ablog ({0:s})'.format(__version__)],
-    install_requires=['Werkzeug', 'Sphinx>=1.6', 'alabaster', 'invoke', 'python-dateutil'],
+    install_requires=['Werkzeug', 'Sphinx>=1.6', 'alabaster', 'invoke', 'python-dateutil', 'sphinx-automodapi'],
     message_extractors={
         'ablog': [
             ('**.html', 'jinja2', None),