Merge pull request #29 from shuup/dev-updates

Update order section of docs

.gitignore

@@ -1,3 +1,5 @@
 *~
 /venv/
 /build/
+.vscode/
+_build/

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,17 +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 running `pip install -r requirements.txt`
+
+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 steps laid 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 cache for this process cause otherwise it will not work!
+
+
+Commiting
+=========
+
+When you have updated or created a new documentation page. Commit it and push normally 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.
@@ -25,8 +69,8 @@ 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
-the CLA.rst file distributed with Shuup Guide.
+the CLA.rst file distributed with Shuup Guide.

requirements-dev.txt

@@ -0,0 +1,15 @@
+# This file is autogenerated by Prequ.  To update, run:
+#
+#   prequ update
+#
+--find-links wheels
+
+click==7.1.2              # via prequ
+livereload==2.6.2         # via sphinx-reload
+prequ==1.4.7
+six==1.15.0               # via livereload
+sphinx-reload==0.2.0
+tornado==6.0.4            # via livereload
+
+# The following packages are considered to be unsafe in a requirements file:
+# pip                       # via prequ

requirements.txt

@@ -19,3 +19,4 @@ recommonmark==0.4.0
 six==1.10.0               # via sphinx
 snowballstemmer==1.2.1    # via sphinx
 Sphinx==1.4.1
+sphinx-reload==0.2.0

setup.cfg

@@ -0,0 +1,21 @@
+[metadata]
+name = shuup-guide
+version = 0.6.0
+
+[bdist_wheel]
+universal = 1
+
+[prequ]
+annotate = yes
+wheel_dir = wheels
+wheel_sources =
+    shuup = git+ssh://[email protected]/shuup/{pkg}@v{ver}
+
+requirements =
+    recommonmark==0.4.0
+    sphinx==3.1.2
+    sphinx-shoop-theme==0.6.0 (wheel from shuup)
+
+requirements-dev =
+    prequ
+    sphinx-reload

source/_static/css/shuup.css

@@ -0,0 +1,16 @@
+body{
+    font-family:"Arial", Helvetica, sans-serif;
+    background-color: aqua;
+}
+
+.center {
+    text-align: center;
+}
+
+ol li p.first {
+    margin-bottom: 0px !important;
+}
+
+ol li {
+    margin-top: 20px !important;
+}

source/_templates/layout.html

@@ -0,0 +1,5 @@
+{# Import the theme's layout. #}
+{% extends "!layout.html" %}
+
+{# Custom CSS overrides #}
+{% set css_files = css_files + ['_static/css/shuup.css'] %}

source/conf.py

@@ -11,11 +11,14 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
-import sphinx_shoop_theme
+from os import path
+import sphinx_shuup_theme
 
 from recommonmark.parser import CommonMarkParser
 
+SOURCE_DIR = path.dirname(path.abspath(__file__))
+STATIC_PATH = path.join(SOURCE_DIR, '_static')
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -47,7 +50,7 @@
 
 # General information about the project.
 project = 'Shuup Guide'
-copyright = '2019, Anders Innovations Inc, DBA Shuup'
+copyright = '2020, Anders Innovations Inc, DBA Shuup'
 author = 'Shuup'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -109,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
@@ -129,12 +132,12 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = 'logo.svg'
+html_logo = path.join(STATIC_PATH, 'logo.svg')
 
 # The name of an image file (relative to this directory) to use as a
 # favicon of the docs.  This file should be a Windows icon file (.ico)
 # being 16x16 or 32x32 pixels large.
-html_favicon = 'favicon.ico'
+html_favicon = path.join(STATIC_PATH, 'favicon.ico')
 
 # 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,