Merge pull request #35 from AaronSachs/master

Moving to sphinx/rtd

.travis.yml

@@ -0,0 +1,13 @@
+language: python
+python:
+  - "2.7"
+before_install:
+ - sudo apt-get update && sudo apt-get install -qq graphviz
+# command to install dependencies
+install: "pip install -q -r requirements.txt --use-mirrors"
+# command to run tests
+script: sphinx-build -nW -b html -d _build/doctrees . _build/html
+# Flags used here, not in `make html`:
+#  -n   Run in nit-picky mode. Currently, this generates warnings for all missing references.
+#  -W   Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1.
+

Makefile

@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# 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
+
+# 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 coverage 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 "  applehelp  to make an Apple Help Book"
+	@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)"
+	@echo "  coverage   to run coverage check of 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/burnoutio.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/burnoutio.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/burnoutio"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/burnoutio"
+	@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."
+
+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."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

README.md

@@ -1,16 +1,33 @@
-# Burnout.io
+[![Documentation Status](https://readthedocs.org/projects/burnoutio-test/badge/?version=latest)](http://burnoutio-test.readthedocs.org/en/latest/?badge=latest)  [![Build Status](https://travis-ci.org/AaronSachs/burnout.io-test.svg?branch=master)](https://travis-ci.org/AaronSachs/burnout.io-test)  [![Join the chat at https://gitter.im/reignite/burnout.io](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/reignite/burnout.io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 [Burnout.io](http://burnout.io) provides resources to prevent IT burnout.
 
-[![Join the chat at https://gitter.im/reignite/burnout.io](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/reignite/burnout.io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 ## Contributing
 We value your ideas! If you'd like to help improve Burnout.io, do whatever works best for you:
 * Open an [issue](https://github.com/reignite/burnout.io/issues/new),
 * [Fork](https://github.com/reignite/burnout.io/fork) the project and submit a PR,
 * Send an [email](mailto:bemosior+burnoutio@gmail.com), or 
 * Reach out on [twitter](https://twitter.com/BenjaminMosior).
 
-## Quick-Start
-1. Markdown files are in the `content` folder.
-2. Theming is in the `themes/burnout` folder.
+###Things you should know:
+
+* This project is written in [reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickstart.html)
+* Hosted by [Read the Docs](http://readthedocs.org/)
+* Tested by rendering in [Sphinx](http://sphinx-doc.org/) on [Travis CI](https://travis-ci.org)
+
+This is the only Markdown file in the repository, as it's not meant to be
+included in the documentation itself.
+
+If you are looking to add content, fix formatting, syntax, typos or other
+wonderful things, please follow this process:
+
+* Install Sphinx: `easy_install Sphinx sphinx_rtd_theme` or `pip install -r requirements.txt`
+* Fork the repository to your own account
+* Check out a branch to make your changes on: `git checkout --branch <my_topic>`
+* Execute `make html` to build the docs in to `_build/`
+* Make your changes
+* Execute `make html` again and verify your changes don't cause any
+  warnings/errors
+* Commit with a descriptive message, and submit a pull request from your branch
+  to `master`
+* We'll review the change, and either merge it or provide some feedback. Community review is also encouraged.

_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6bb42c73e0b0708de2f7cae0b2c6b102
+tags: 645f666f9bcd5a90fca523b33c5a78b7

content/actionables.md → _build/html/_sources/actionables.txt

@@ -1,40 +1,52 @@
-/*
-Title: Actionables
-Description: What can you do to combat burnout? Learn how to restore a healthy work-life balance.
-Placing: 0
-*/
+#####################
+Actionables
+#####################
+
+Steps to Fighting Burnout
+=========================
 
-# What can I do?
 The general consensus seems to be that there are three steps in fighting against burnout:
 
-## 1. Determine if it's self-inflicted.
+1. Determine if it's self-inflicted.
+----------------------------------------
+
 If you can take some time off, be removed from on-call for a bit, or allow that next task to wait until you become yourself again, *do it*. Get some sleep and figure out what it will take to remove the strain.
 
 The objective is to maintain a healthy work-life balance. **Stop being a hero.** There is no benefit if the toll is so great that your personal life and relationships suffer.
 
 Make sure when you aren't in the office you spend some time doing something completely unrelated to your profession. We are all passionate about what we do, but if your hobby happens to be the same as your job, you may experience burnout much faster.
 
-## 2. Determine if it's an external pressure.
+2. Determine if it's an external pressure.
+-------------------------------------------
+
 * Management says they need that new feature *now*. 
 * You're not allowed to fix the technical debt and apply band-aids instead.
 * You're constantly fighting fires.
 * The only reason everything is working is because you put in too many hours a week.
 
 If these sorts of situations sound familiar and you're burning out, it's time for the external factors to change.
 
-### Find out what is causing the problem.
+Find out what is causing the problem.
+``````````````````````````````````````````
+
 Burnout can be caused by mindless repetition and interruptions. Or it can be middle-management setting unrealistic deadlines. Document the causes, then find ways to alleviate them.
 
-### Communicate the burnout to people who can help. 
+Communicate the burnout to people who can help. 
+```````````````````````````````````````````````````````````````
+
 Sometimes all it takes is explaining the problem and talking it out with management and coworkers. Middle-management should exist to help specifically with these kinds of problems.
 
-### Say "no" to unreasonable requests.
+Say "no" to unreasonable requests.
+``````````````````````````````````````````
+
 Say "no" if a request is unreasonable, but try to provide feedback in order to prevent the pattern from continuing.
 
-Don't allow yourself to be talked down when it comes to time estimates. Instead, learn <a target="_blank" href="http://www.liquidplanner.com/blog/defense-dark-art-estimation-bargaining/">"Defense Against the Dark Art of Estimation Bargaining"</a>
+Don't allow yourself to be talked down when it comes to time estimates. Instead, learn `Defense Against the Dark Art of Estimation Bargaining <http://www.liquidplanner.com/blog/defense-dark-art-estimation-bargaining>`_
+
+"Yes, and..."
+`````````````````````
 
-### "Yes, and..."
-If "no" doesn't work, try using the <a href="http://www.huffingtonpost.com/liz-orsquo/cant-say-no-say-yes-instead_b_4583052.html" target="_blank">"Yes, and..." technique</a> in order to emphasize your willingness to work with the requester but also take the opportunity to establish some boundaries and tradeoffs. 
+If "no" doesn't work, try using the `Yes, and... technique <http://www.huffingtonpost.com/liz-orsquo/cant-say-no-say-yes-instead_b_4583052.html>`_ in order to emphasize your willingness to work with the requester but also take the opportunity to establish some boundaries and tradeoffs. 
 
 For example:
 
@@ -43,13 +55,19 @@ For example:
 
 An alternative way of phrasing "Yes, and..." is to say, "You can have everything you want, just not all at once."
 
-### Let it fail.
+Let it fail.
+`````````````````````
+
 If your cries for change aren't working, allow the consequences (downtime, no new features, missed deadlines, etc.) to speak for themselves. If the choice is between your mental health and your work, one of those is going to win (and it needs to be your mental health)! Of course, this point should be considered with caution (don't be malicious or reckless just to prove a point).
 
-## 3. Move on (or take a break).
+3. Move on (or take a break).
+------------------------------------------
+
 If your organization can't change enough to help you prevent burnout, it may be time to leave. A recurring point with people who have escaped burnout seems to be "I'm so much happier now that I work for a company that allows me to maintain a good work-life balance." There's no guarantee, but at least you can take the opportunity to fairly evaluate a potential job during the interview process.
 
 It may also be better to take a long vacation, far away from emails and business-speak.
 
-### A note on preparation.
-It's a really good idea to set aside emergency funds to use in case you have to exercise option 3. Open up a savings account and allocate a percentage of your income towards your potential burnout escape.
+A note on preparation.
+``````````````````````````````````````````
+
+It's a really good idea to set aside emergency funds to use in case you have to exercise option 3. Open up a savings account and allocate a percentage of your income towards your potential burnout escape.