Permalink
Browse files

Rename website to docs

  • Loading branch information...
1 parent 7545eb9 commit 0fd489f0865e1c03e6c4758840180bcd70169f55 @jamesroutley jamesroutley committed Jul 12, 2017
Showing with 32 additions and 2,206 deletions.
  1. +7 −7 .gitignore
  2. 0 {website → docs}/Gemfile
  3. 0 {website → docs}/Gemfile.lock
  4. +25 −163 docs/Makefile
  5. 0 {website → docs}/README.md
  6. 0 {website → docs}/_api/Makefile
  7. 0 {website → docs}/_api/conf.py
  8. 0 {website → docs}/_api/index.rst
  9. 0 {website → docs}/_api/make.bat
  10. 0 {website → docs}/_config.yml
  11. 0 {website → docs}/_includes/docs_navigation.html
  12. 0 {website → docs}/_includes/footer.html
  13. 0 {website → docs}/_includes/head.html
  14. 0 {website → docs}/_includes/navbar.html
  15. 0 {website → docs}/_layouts/docs.html
  16. 0 {website → docs}/_layouts/home.html
  17. 0 {website → docs}/_layouts/page.html
  18. 0 {website → docs}/about.md
  19. +0 −144 docs/advanced_patterns.rst
  20. 0 {website → docs}/assets/css/sceptre.css
  21. 0 {website → docs}/assets/css/syntax.css
  22. +0 −1 docs/authors.rst
  23. +0 −75 docs/command_line.rst
  24. +0 −289 docs/conf.py
  25. +0 −1 docs/contributing.rst
  26. 0 {website → docs}/docs/architecture.md
  27. 0 {website → docs}/docs/cli.md
  28. 0 {website → docs}/docs/environment_config.md
  29. 0 {website → docs}/docs/faq.md
  30. 0 {website → docs}/docs/get_started.md
  31. 0 {website → docs}/docs/hooks.md
  32. 0 {website → docs}/docs/index.md
  33. 0 {website → docs}/docs/install.md
  34. 0 {website → docs}/docs/resolvers.md
  35. 0 {website → docs}/docs/stack_config.md
  36. 0 {website → docs}/docs/templates.md
  37. 0 {website → docs}/docs/terminology.md
  38. +0 −176 docs/environment_config.rst
  39. +0 −9 docs/examples.rst
  40. +0 −62 docs/faq.rst
  41. +0 −139 docs/get_started.rst
  42. +0 −1 docs/history.rst
  43. 0 {website → docs}/index.html
  44. +0 −37 docs/index.rst
  45. +0 −22 docs/installation.rst
  46. +0 −32 docs/introduction.rst
  47. +0 −242 docs/make.bat
  48. +0 −7 docs/modules.rst
  49. +0 −41 docs/python_module.rst
  50. +0 −30 docs/sceptre.hooks.rst
  51. +0 −46 docs/sceptre.resolvers.rst
  52. +0 −102 docs/sceptre.rst
  53. +0 −454 docs/stack_config.rst
  54. +0 −57 docs/templates.rst
  55. +0 −30 docs/terminology.rst
  56. +0 −39 website/Makefile
View
@@ -105,15 +105,15 @@ Temporary Items
# Jekyll settings
.bundle/
-website/vendor/*
+docs/vendor/*
_site/
.sass-cache/
.jekyll-metadata
# Sphinx docs
-/website/docs/api
-/website/_api/_build/
-/website/_api/modules.rst
-/website/_api/sceptre.rst
-/website/_api/sceptre.hooks.rst
-/website/_api/sceptre.resolvers.rst
+/docs/docs/api
+/docs/_api/_build/
+/docs/_api/modules.rst
+/docs/_api/sceptre.rst
+/docs/_api/sceptre.hooks.rst
+/docs/_api/sceptre.resolvers.rst
File renamed without changes.
File renamed without changes.
View
@@ -1,177 +1,39 @@
-# Makefile for Sphinx documentation
-#
+.PHONY: clean
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
+SHA1 = $(shell git rev-parse --short HEAD)
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
+GIT_TAG = $(shell git describe --abbrev=0 --tags | sed 's/\./-/g')
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
- @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 " xml to make Docutils-native XML files"
- @echo " pseudoxml to make pseudoxml-XML files for display purposes"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+install:
+ bundle install --path vendor
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)https://github.com/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/sceptre.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sceptre.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/sceptre"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sceptre"
- @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."
-
-latexpdfja:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through platex and dvipdfmx..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
- @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."
+ rm -rf _site/
+ rm -rf .sass-cache/
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+website:
+ bundle exec jekyll build
-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)."
+build-latest:
+ bundle exec jekyll build --baseurl /latest
-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."
+build-tag:
+ bundle exec jekyll build --baseurl /$(GIT_TAG)
-gettext:
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
- @echo
- @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+build-dev:
+ bundle exec jekyll build --baseurl /dev
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
+build-commit:
+ bundle exec jekyll build --baseurl /$(SHA1)
-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."
+serve-latest:
+ bundle exec jekyll serve --baseurl /latest
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
+serve-tag:
+ bundle exec jekyll serve --baseurl /$(GIT_TAG)
-xml:
- $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
- @echo
- @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+serve-dev:
+ bundle exec jekyll serve --baseurl /dev
-pseudoxml:
- $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
- @echo
- @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+serve-commit:
+ bundle exec jekyll serve --baseurl /$(SHA1)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
View
@@ -1,144 +0,0 @@
-.. highlight:: shell
-
-=================
-Advanced Patterns
-=================
-
-This section details patterns and techniques that advanced users may want to use.
-
-
-.. _using_an_environments_connection_manager:
-
-Using an Environment's Connection Manager
------------------------------------------
-
-When using Sceptre as a Python module, it is possible to make use of an environment's connection manager to make Boto3 calls to that environment's account and region, using the credentials set in environment config.
-
-Once an environment is initialised, the connection manager can be accessed as follows:
-
-.. code-block:: python
-
- from sceptre.environment import Environment
-
- env = Environment(
- sceptre_dir="string",
- environment_path="string",
- options={}
- )
-
- client = env.connection_manager._get_client("<service name>")
-
-Where <service name> can be any of the services `supported by Boto3 <http://boto3.readthedocs.io/en/latest/reference/services/index.html>`_.
-
-This client is a normal Boto3 client, and can be used as such.
-
-.. _user_defined_resolvers:
-
-Custom Resolvers
-----------------------
-
-Users can define their own resolvers which are used by Sceptre to resolve the value of a parameter before it is passed to the CloudFormation template.
-
-A resolver is a Python class which inherits from abstract base class ``Resolver`` found in the ``sceptre.resolvers module``.
-
-Resolvers are require to implement a ``resolve()`` function that takes no parameters and to call the base class initializer on initialisation.
-
-Resolvers may have access to ``argument``, ``stack_config``, ``environment_config`` and ``connection_manager`` as an attribute of ``self``. For example ``self.stack_config``.
-
-This class should be defined in a file which is located at::
-
- <sceptre_project_dir>/resolvers/<your resolver>.py
-
-An arbitrary file name may be used as it is not checked by Sceptre.
-
-The following python module template can be copied and used:
-
-.. code-block:: python
-
- from sceptre.resolvers import Resolver
-
- class CustomResolver(Resolver):
-
- def __init__(self, *args, **kwargs):
- super(CustomResolver, self).__init__(*args, **kwargs)
-
- def resolve(self):
- """
- resolve is the method called by Sceptre. It should carry out the work
- intended by this resolver. It should return a string to become the
- final value.
-
- self.argument is available from the base class and contains the
- argument defined in the sceptre config file (see below)
-
- The following attributes may be available from the base class:
- self.stack_config (A dict of data from <stack_name>.yaml)
- self.environment_config (A dict of data from config.yaml)
- self.connection_manager (A connection_manager)
- """
- return self.argument
-
-
-This resolver can be used in a stack config file with the following syntax::
-
- template_path: <...>
- parameters:
- param1: !<your_resolver_name> <value> # <your resolver name> is the lower camel-case version
- # of your class name, e.g `custom_resolver`
- # <value> will be passed to the
- # resolver's resolve() method.
-
-
-.. _user_defined_sceptre_hooks:
-
-Custom Hooks
-------------------
-
-Users can define their own custom hooks, allowing users to extend hooks and integrate additional functionality into Sceptre projects.
-
-A hook is a Python class which inherits from abstract base class ``Hook`` found in the ``sceptre.hooks module``.
-
-Hooks are require to implement a ``run()`` function that takes no parameters and to call the base class initializer on initialisation.
-
-Hooks may have access to ``argument``, ``stack_config``, ``environment_config`` and ``connection_manager`` as an attribute of ``self``. For example ``self.stack_config``.
-
-Hook classes are defined in python files located at::
-
- <sceptre_project_dir>/hooks/<your hook>.py
-
-Sceptre retrieves any class which inherits from base class Hook found within this directory. The name of the hook is the class name in snake case format. e.g. ``class CustomHook`` is ``custom_hook``. An arbitrary file name may be used as it is not checked by Sceptre.
-
-The following python module template can be copied and used:
-
-.. code-block:: python
-
- from sceptre.hooks import Hook
-
-
- class CustomHook(Hook):
-
- def __init__(self, *args, **kwargs):
- super(CustomHook, self).__init__(*args, **kwargs)
-
- def run(self):
- """
- run is the method called by Sceptre. It should carry out the work
- intended by this hook.
-
- self.argument is available from the base class and contains the
- argument defined in the sceptre config file (see below)
-
- The following attributes may be available from the base class:
- self.stack_config (A dict of data from <stack_name>.yaml)
- self.environment_config (A dict of data from config.yaml)
- self.connection_manager (A connection_manager)
- """
- print self.argument
-
-
-This hook can be used in a stack config file with the following syntax::
-
- template_path: <...>
- hooks:
- before_create:
- - !custom_hook <argument> # The argument is accessible via self.argument
File renamed without changes.
File renamed without changes.
View
@@ -1 +0,0 @@
-.. include:: ../AUTHORS.rst
Oops, something went wrong.

0 comments on commit 0fd489f

Please sign in to comment.