Merge pull request cyclus#170 from cyclus/docker

docker build option

Makefile

@@ -24,28 +24,32 @@ I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(GH_SOURCE_DIR)
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  gh-preview to build HTML in directory $BUILDDIR for testing"
-	@echo "  gh-revert  to cleanup HTML build in directory $BUILDDIR after testing"
-	@echo "  gh-publish final build and push from source branch to master branch"
-	@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)"
+	@echo "  gh-preview  to build HTML in directory $BUILDDIR for testing"
+	@echo "  gh-revert   to cleanup HTML build in directory $BUILDDIR after testing"
+	@echo "  gh-publish  final build and push from source branch to master branch"
+	@echo "  html        to make standalone HTML files"
+	@echo "  html-docker to make standalone HTML files inside a docker container"
+	@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)"
+
+html-docker gh-preview-docker:
+	docker run -w /cyclus.github.com -v $(PWD):/cyclus.github.com cyclus/fuelcycle.org-deps make gh-preview
 
 gh-clean gh-revert clean:
 	-rm -rf $(BUILDDIR)

README.rst

@@ -47,6 +47,11 @@ branch, you may always run::
 
     make html
 
+Or if you have docker, you can forget about the other dependencies and just
+run::
+
+    make html-docker
+
 Best practice workflow for contributing to site changes
 --------------------------------------------------------
 
@@ -70,7 +75,13 @@ Best practice workflow for contributing to site changes
 
    This will build a version of the site in the `gh-build` directory of
    your branch, `add_some_info`.  You can load it directly in a local
-   browser.
+   browser.  Or if you have docker installed, you can optionally use the
+   docker preview target:
+
+   ``make gh-preview-docker``
+
+   to build the website inside a docker container with all the correct
+   dependencies and configuration taken care of automagically.
 
 6. Repeat steps 4-5 until satisfied.
 

docker/README.rst

@@ -0,0 +1,9 @@
+
+``fuelcycle.org-deps`` contains a dockerfile with all dependencies for
+building the website.  This is used by the docker based build targets added to
+the makefile.  This image will need to be updated and repushed to docker hub
+periodically when dependencies for the website need updating.  Particularly,
+this image will need to be rebuilt whenever there is a new release of
+cyclus+cycamore+cymetric - otherwise new changes in those projects/repos won't
+show up/work on the website.
+

docker/fuelcycle.org-deps/Dockerfile

@@ -0,0 +1,8 @@
+
+FROM cyclus/cymetric
+
+RUN apt-get install -y --force-yes python3-pip \
+    python3-sphinx \
+    python3-cloud-sptheme
+RUN pip3 install sphinxcontrib-bibtex
+

source/arche/tour.rst

@@ -99,9 +99,7 @@ ability to help automate some documentation:
   #pragma cyclus note {"doc": "A stub facility is provided as a skeleton " \
                               "for the design of new facility agents."}
 
-Again, ``#pragma cyclus note`` is explained further in :ref:`cycpp`; however you
-can see the results of using this particular directive in our own Stub archetype
-:doc:`documentation </user/stubagents>`.
+Again, ``#pragma cyclus note`` is explained further in :ref:`cycpp`.
 
 Continuing along, we reach the final three member functions, each of which are
 defined on the base ``cyclus::Agent`` class and are overrode by the

source/user/index.rst

@@ -93,9 +93,6 @@ and individuals for use by |Cyclus| users.
    :maxdepth: 2
 
    cyclusagents
-   stubagents
-
-
 
 Visualization & Analysis
 --------------------------