Create changelog, update README with theme testing instructions

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Enter here all the changes made to the development version
+
+### Change
+
+- Update the sphinx version
+- Update the order admin section

Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = build
+BUILDDIR      = _build
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

README.rst

@@ -6,44 +6,61 @@ This is a guide for merchants on how to use Shuup.
 For more information about Shuup, see https://shuup.com/ and `Shuup
 at GitHub <https://github.com/shuup/shuup>`_.
 
+
 Set up
-------
+======
 
 1. Install requirements by runing `pip install -r requirements.txt`
 
-2. Run sphinx-reload . in the root of the project
+2. Run `sphinx-reload .` in the root of the project
 
     Then open up http://localhost:5500.
 
     All change made to the .rst files in the source
     folder will automatically reload the server.
 
+
+Test sphinx shuup theme
+=======================
+
+1. Follow the setps layed out under `Development with shuup-guide` in the sphinx shuup theme README file
+2. Run `make clean`
+3. Run `sphinx-reload .`
+
+.. warning::
+    Remember to clear all chache for this process cause otherwise it will not work!
+
+
 Commiting
----------
+=========
 
 When you have updated or created a new documentation page. Commit it and push normaly but make the PR **from your branch to dev-updates**.
 
+
 Creating new pages
-------------------
+==================
 
 Create a new .rst file in the `source/` folder. Then add the name of the file to the `source/index.rst` file in the `toctree`.
 
+
 Formatting
-----------
+==========
 
 Look how the source/order.rst is formatted to see how you should format the page you are working on.
 
+
 Copyright
----------
+=========
 
 Copyright (C) 2019 by Anders Innovations Inc, DBA Shuup. [email protected]
 
 Shuup is International Registered Trademark & Property of Anders Innovations 
 Inc, DBA Shuup, Business Address: 1500 West Georgia St Suite 1300, Vancouver, 
 BC, V6G 2Z6.
 
+
 License
--------
+=======
 
 Shuup Guide is licensed under a Creative Commons Attribution-ShareAlike
 4.0 International License.
@@ -52,7 +69,7 @@ You should have received a copy of the license along with this work.  If
 not, see http://creativecommons.org/licenses/by-sa/4.0/.
 
 CLA
----
+===
 
 Contributor License Agreement is required for any contribution to this
 project.  Agreement is signed as a part of pull request process.  See

source/conf.py

@@ -12,7 +12,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 from os import path
-import sphinx_shoop_theme
+import sphinx_shuup_theme
 
 from recommonmark.parser import CommonMarkParser
 
@@ -112,8 +112,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinx_shoop_theme'
-html_theme_path = [sphinx_shoop_theme.get_html_theme_path()]
+html_theme = 'sphinx_shuup_theme'
+html_theme_path = [sphinx_shuup_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

source/orders.rst

@@ -285,7 +285,7 @@ Basic details
 3. **Actions**
 
    Actions are only available on orders that aren't completed.
-   This is where you can change the address of the order. :ref:`order address change`.
+   This is where you can change the address of the order.
    Depending on if the order is payed for or not you will be able to create a refund or create a payment.
    Click on either the `Create payment` or `Create refund` and then follow the documentation from :ref:`order payment`.
 
@@ -298,6 +298,8 @@ Basic details
 .. raw:: html
    <---- #TODO: Link to order status part under point 2----->
 
+.. _order detail payment:
+
 Payments
 --------