Convert to Sphinx! (#55)

* Convert to Sphinx!

* Try to fix MarkupSafe dependency

* Use fix provided by Platform.sh team

* Use ReadTheDocs theme for now

* More tweaks to build

* Port theme work by qodeone

* Content tweaks

* Tweaks to content

* More tweaks

* Fix bad import

* Try styling pygments

* Revert "Try styling pygments"

This reverts commit 2f0ccc2.

* Hide the toggles

* Final tweaks

* Update Travis

Author: mglaman

.gitignore

@@ -17,3 +17,8 @@ _book
 
 .DS_Store
 .idea
+
+/_build/doctrees
+/_build/html
+/_build/epub
+*.pyc

.platform.app.yaml

@@ -5,21 +5,19 @@
 name: php
 
 # The toolstack used to build the application.
-type: php
+type: "php"
+build:
+    flavor: "composer"
 
 # The configuration of app when it is exposed to the web.
 web:
     # The public directory of the app, relative to its root.
-    document_root: "/_book"
-    passthru: index.html
+    document_root: "/_build/html"
     index_files:
       - index.html
-    expires: 300
     whitelist:
       - \.html$
-
-      # GitBook search indexes.
-      - search_index\.json$
+      - \.txt$
 
       # CSS and Javascript.
       - \.css$
@@ -39,22 +37,23 @@ web:
       # robots.txt.
       - /robots\.txt$
 
-      # gitbook ico
       - \.ico$
 
 # The size of the persistent disk of the application (in MB).
 disk: 2048
 
 # Build time dependencies.
 dependencies:
-  nodejs:
-    gitbook-cli: "*"
+  python:
+    virtualenv: 15.1.0
 
 # The hooks that will be performed when the package is deployed.
 hooks:
     build: |
-      gitbook install
-      gitbook build
-    # We run deploy hook after your application has been deployed and started.
-    deploy: |
-      cp -f /app/images/favicon.ico /app/_book/gitbook/images/favicon.ico
+      virtualenv .virtualenv
+      . .virtualenv/bin/activate
+      # Platform.sh currently sets PIP_USER=1.
+      export PIP_USER=
+      pip install pip==9.0.1 wheel==0.29.0
+      pip install -r requirements.txt
+      make -C _build html

.platform/services.yaml

@@ -0,0 +1 @@
+# Nothing

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+
+python: 2.7
+
+sudo: false
+cache:
+  directories: [$HOME/.cache/pip]
+
+install: pip install -r requirements.txt
+
+script: ./build.sh

README.md

@@ -1,53 +1,53 @@
 # Summary
 
-* [Introduction](README.md)
-* [Commerce 1.x](v1/README.md)
-* [Commerce 2.x](v2/README.md)
-    * [Getting started](v2/getting-started.md)
-        * [Composer: the what, why, and how](v2/getting-started/composer.md)
-        * [Installing Drupal Commerce](v2/getting-started/install.md)
-        * [Applying updates](v2/getting-started/update.md)
+* [Introduction](README.rst)
+* [Commerce 1.x](v1/README.rst)
+* [Commerce 2.x](v2/README.rst)
+    * [Getting started](v2/getting-started.rst)
+        * [Composer: the what, why, and how](v2/getting-started/composer.rst)
+        * [Installing Drupal Commerce](v2/getting-started/install.rst)
+        * [Applying updates](v2/getting-started/update.rst)
         * Contributing
-            * [Setting up an environment](v2/getting-started/contributing/development-environment.md)
-            * [Get started with contributing](v2/getting-started/contributing/developing.md)
-    * [Libraries and dependencies](v2/building-blocks/index.md)
-        * [Address](v2/building-blocks/address/README.md)
-            * [Zones](v2/building-blocks/address/zones.md)
-        * [Profile](v2/building-blocks/profile.md)
-        * [State Machine](v2/building-blocks/state-machine.md)
-        * [Inline Entity Form](v2/building-blocks/ief.md)
-        * [Currency](v2/building-blocks/currency.md)
-    * [Setting up stores](v2/store.md)
-    * [Managing products](v2/product/index.md)
-        * [Setup product attributes](v2/product/product-attributes.md)
-        * [Make a product](v2/product/products.md)
-        * [Create a product type](v2/product/product-type.md)
-        * [Purchasable Entities](v2/product/purchasable-entities.md)
-    * [Catalog and product pages](v2/product/catalog-and-product-pages.md)
-        * [Create a product catalog](v2/product/create-a-product-catalog.md)
-        * [Customize the add to cart form](v2/product/customize-the-add-to-cart-form.md)
-        * [Theme a product page](v2/product/theme-a-product-page.md)
-    * [Product merchandising](v2/using-promotions.md)
-        * [Create a promotion](v2/creating-a-promotion.md)
-    * [Working with orders](v2/orders/index.md)
-        * [Understanding order types](v2/orders/order-types.md)
-        * [Orders and order items](v2/orders/order-items.md)
+            * [Setting up an environment](v2/getting-started/contributing/development-environment.rst)
+            * [Get started with contributing](v2/getting-started/contributing/developing.rst)
+    * [Libraries and dependencies](v2/building-blocks/index.rst)
+        * [Address](v2/building-blocks/address/README.rst)
+            * [Zones](v2/building-blocks/address/zones.rst)
+        * [Profile](v2/building-blocks/profile.rst)
+        * [State Machine](v2/building-blocks/state-machine.rst)
+        * [Inline Entity Form](v2/building-blocks/ief.rst)
+        * [Currency](v2/building-blocks/currency.rst)
+    * [Setting up stores](v2/store.rst)
+    * [Managing products](v2/product/index.rst)
+        * [Setup product attributes](v2/product/product-attributes.rst)
+        * [Make a product](v2/product/products.rst)
+        * [Create a product type](v2/product/product-type.rst)
+        * [Purchasable Entities](v2/product/purchasable-entities.rst)
+    * [Catalog and product pages](v2/product/catalog-and-product-pages.rst)
+        * [Create a product catalog](v2/product/create-a-product-catalog.rst)
+        * [Customize the add to cart form](v2/product/customize-the-add-to-cart-form.rst)
+        * [Theme a product page](v2/product/theme-a-product-page.rst)
+    * [Product merchandising](v2/using-promotions.rst)
+        * [Create a promotion](v2/creating-a-promotion.rst)
+    * [Working with orders](v2/orders/index.rst)
+        * [Understanding order types](v2/orders/order-types.rst)
+        * [Orders and order items](v2/orders/order-items.rst)
         * Advanced topics
-            * [Order Processing](v2/orders/order-processing.md)
+            * [Order Processing](v2/orders/order-processing.rst)
             * Code recipes
-    * [Configuring checkout](v2/checkout/index.md)
-        * [Allowing guest checkout, or account login](v2/checkout/guest.md)
-        * [Customizing your checkout](v2/checkout/customize.md)
+    * [Configuring checkout](v2/checkout/index.rst)
+        * [Allowing guest checkout, or account login](v2/checkout/guest.rst)
+        * [Customizing your checkout](v2/checkout/customize.rst)
         * Advanced topics
-            * [Creating a checkout pane plugin](v2/checkout/checkout-pane-plugin.md)
-            * [Creating a checkout flow plugin](v2/checkout/creating-a-checkout-flow-plugin.md)
-    * [Payments](v2/setting-up-payments.md)
-        * [Install a payment gateway](v2/install-a-payment-gateway.md)
-        * [Managing order payments](v2/managing-order-payments.md)
-    * [Code recipes](v2/recipes/index.md)
-        * [Stores](v2/recipes/stores.md)
-        * [Variations](v2/recipes/variations.md)
-        * [Attributes](v2/recipes/attributes.md)
-        * [Products](v2/recipes/products.md)
-        * [Orders](v2/recipes/orders.md)
+            * [Creating a checkout pane plugin](v2/checkout/checkout-pane-plugin.rst)
+            * [Creating a checkout flow plugin](v2/checkout/creating-a-checkout-flow-plugin.rst)
+    * [Payments](v2/setting-up-payments.rst)
+        * [Install a payment gateway](v2/install-a-payment-gateway.rst)
+        * [Managing order payments](v2/managing-order-payments.rst)
+    * [Code recipes](v2/recipes/index.rst)
+        * [Stores](v2/recipes/stores.rst)
+        * [Variations](v2/recipes/variations.rst)
+        * [Attributes](v2/recipes/attributes.rst)
+        * [Products](v2/recipes/products.rst)
+        * [Orders](v2/recipes/orders.rst)
 

SUMMARY.md

@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = .
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -c $(BUILDDIR) -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ../
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Symfony.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Symfony.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Symfony"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Symfony"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."