Nicer Changelog (#397)

* Nicer Changelog

* doc: Update style

Author: henryiii

MANIFEST.in

@@ -25,5 +25,5 @@ global-exclude .ipynb_checkpoints
 global-exclude *.py[co]
 global-exclude __pycache__
 
-include CMakeLists.txt LICENSE README.md setup.py dev-requirements.txt setup.cfg pyproject.toml CONTRIBUTING.md CHANGELOG.md
+include CMakeLists.txt LICENSE README.md setup.py dev-requirements.txt setup.cfg pyproject.toml CONTRIBUTING.md
 recursive-include extern *LICENSE*

README.md

@@ -13,8 +13,8 @@
 [![Scikit-HEP][sk-badge]](https://scikit-hep.org/)
 
 Python bindings for [Boost::Histogram][] ([source][Boost::Histogram source]), a
-C++14 library. This should become one of the [fastest libraries][] for
-histogramming, while still providing the power of a full histogram object.
+C++14 library. This is of the [fastest libraries][] for
+histogramming, while still providing the power of a full histogram object. See [what's new](./docs/CHANGELOG.md).
 
 ## Installation
 

CHANGELOG.md docs/CHANGELOG.mdCHANGELOG.md renamed to docs/CHANGELOG.md

@@ -1,4 +1,7 @@
-## Version 0.8.0
+# What's new in boost-histogram
+
+## Version 0.8
+### Version 0.8.0
 
 This version was released just before SciPy 2020 and Boost 1.74. Highlights
 include better accumulator views, simpler summing, better NumPy and Pandas
@@ -59,7 +62,8 @@ on Boost.Histogram's C++ tools for actions like cropping.
 [#393]: https://github.com/scikit-hep/boost-histogram/pull/393
 
 
-## Version 0.7.0
+## Version 0.7
+### Version 0.7.0
 
 This version removes deprecated functionality, and has several backend
 improvements. The most noticeable user-facing change is the multithreaded fill
@@ -93,6 +97,9 @@ use. Several small bugs have been fixed.
 [#320]: https://github.com/scikit-hep/boost-histogram/pull/320
 [#325]: https://github.com/scikit-hep/boost-histogram/pull/325
 
+
+## Version 0.6
+
 ### Version 0.6.2
 
 Common analysis tasks are now better supported. Much more complete
@@ -142,7 +149,7 @@ library. Using Boost 1.72 release.
 
 
 
-## Version 0.6
+### Version 0.6.0
 
 
 This version fills out most of the remaining features missing from the 0.5.x
@@ -219,6 +226,8 @@ transition existing 0.5.x code to the new API.
 [#264]: https://github.com/scikit-hep/boost-histogram/pull/264
 
 
+## Version 0.5
+
 ### Version 0.5.2
 
 #### User changes:
@@ -269,7 +278,7 @@ transition existing 0.5.x code to the new API.
 [#159]: https://github.com/scikit-hep/boost-histogram/pull/159
 
 
-## Version 0.5
+### Version 0.5.0
 
 First beta release and beginning of the changelog.
 

docs/conf.py

@@ -26,7 +26,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "boost_histogram"
-copyright = "2019, Henry Schreiner, Hans Dembinski"
+copyright = "2020, Henry Schreiner, Hans Dembinski"
 author = "Henry Schreiner, Hans Dembinski"
 
 # It is better to use pkg_resources, but we can't build on RtD
@@ -72,6 +72,9 @@
 
 # -- Options for Notebook input ----------------------------------------------
 
+html_logo = "_images/BoostHistogramPythonLogo.png"
+html_title = "boost-histogram docs"
+
 nbsphinx_execute = "never"  # Can change to auto
 
 highlight_language = "python3"
@@ -86,7 +89,20 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
+
+# Config for the Sphinx book
+
+html_baseurl = "https://boost-histogram.readthedocs.io/en/latest/"
+
+
+html_theme_options = {
+    "home_page_in_toc": True,
+    "repository_url": "https://github.com/scikit-hep/boost-histogram",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.rst

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 .. image:: _images/BoostHistogramPythonLogo.png
-  :width: 400
+  :width: 70%
   :alt: Boost histogram logo
   :align: center
 
@@ -55,6 +55,7 @@ See :ref:`usage-quickstart` for more.
 
    usage/installation
    usage/quickstart
+   CHANGELOG
    usage/histogram
    usage/axes
    usage/storage

docs/requirements.txt

@@ -2,5 +2,5 @@ nbsphinx
 numpy
 recommonmark>=0.5.0
 Sphinx>=2.0.0
+sphinx-book-theme
 sphinx_copybutton
-sphinx_rtd_theme

docs/usage/installation.rst

@@ -41,22 +41,16 @@ System                      Arch        Python versions
 =========================== =========== =======================
 ManyLinux1 (custom GCC 9.2) 64 & 32-bit 2.7, 3.5, 3.6, 3.7, 3.8
 ManyLinux2010               64-bit      2.7, 3.5, 3.6, 3.7, 3.8
-macOS 10.9+                 64-bit      2.7, 3.6, 3.7, 3.8
-Windows                     64 & 32-bit 2.7, 3.6, 3.7, 3.8
+macOS 10.9+                 64-bit      2.7, 3.5, 3.6, 3.7, 3.8
+Windows                     64 & 32-bit 2.7, 3.5, 3.6, 3.7, 3.8
 =========================== =========== =======================
 
--  Linux: I’m not supporting 3.4 because I have to build the Numpy
-   wheels to do so.
 -  manylinux1: Using a custom docker container with GCC 9.2; should work
-   but can’t be called directly other compiled extensions unless they do
+   but can't be called directly other compiled extensions unless they do
    the same thing (think that’s the main caveat). Supporting 32 bits
    because it’s there.
 -  manylinux2010: Requires pip 10+ and a version of Linux newer than
-   2010. This is very new technology.
--  MacOS: Uses the dedicated 64 bit 10.9+ Python.org builds. We are not
-   supporting 3.5 because those no longer provide binaries (could add a
-   32+64 fat 10.6+ that really was 10.9+, but not worth it unless there
-   is a need for it).
+   2010.
 -  Windows: PyBind11 requires compilation with a newer copy of Visual
    Studio than Python 2.7’s Visual Studio 2008; you need to have the
    `Visual Studio 2015