improve documentation structure

This renames HISTORY.rst -> NEWS (convention in Scrapy and w3lib) and shows the readme in first page of documentation site.
scrapy · Apr 27, 2016 · 9b589ac · 9b589ac
1 parent 641d8f2
commit 9b589ac
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 15 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,6 +1,6 @@
 include AUTHORS.rst
 include CONTRIBUTING.rst
-include HISTORY.rst
+include NEWS
 include LICENSE
 include README.rst
 

diff --git a/HISTORY.rst → NEWS b/HISTORY.rst → NEWS
@@ -4,65 +4,65 @@ History
 -------
 
 1.0.2 (2016-04-26)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Fix bug in exception handling causing original traceback to be lost
 * Added docstrings and other doc fixes
 
 1.0.1 (2015-08-24)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Updated PyPI classifiers
 * Added docstrings for csstranslator module and other doc fixes
 
 
 1.0.0 (2015-08-22)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Documentation fixes
 
 
 0.9.6 (2015-08-14)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Updated documentation
 * Extended test coverage
 
 
 0.9.5 (2015-08-11)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Support for extending SelectorList
 
 
 0.9.4 (2015-08-10)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Try workaround for travis-ci/dpl#253
 
 
 0.9.3 (2015-08-07)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Add base_url argument
 
 
 0.9.2 (2015-08-07)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 * Rename module unified -> selector and promoted root attribute
 * Add create_root_node function
 
 
 0.9.1 (2015-08-04)
----------------------
+~~~~~~~~~~~~~~~~~~
 
 * Setup Sphinx build and docs structure
 * Build universal wheels
 * Rename some leftovers from package extraction
 
 
 0.9.0 (2015-07-30)
----------------------
+~~~~~~~~~~~~~~~~~~
 
 * First release on PyPI.
diff --git a/docs/history.rst b/docs/history.rst
@@ -0,0 +1,2 @@
+.. include:: ../NEWS
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,15 +3,16 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Parsel's documentation!
-======================================
+.. include:: ../README.rst
+
+Parsel Documentation Contents
+=============================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   readme
    installation
    usage
    history

diff --git a/docs/readme.rst b/docs/readme.rst
@@ -0,0 +1,2 @@
+.. include:: ../README.rst
+
diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@
 with open('README.rst') as readme_file:
     readme = readme_file.read()
 
-with open('HISTORY.rst') as history_file:
+with open('NEWS') as history_file:
     history = history_file.read().replace('.. :changelog:', '')
 
 test_requirements = [