Permalink
Browse files

Nuke old docs tree, update other refs to docs files

  • Loading branch information...
bitprophet committed Apr 7, 2014
1 parent f49d6cd commit 6f8049a9a7c02dc58c48ffb3cda1a9958ed23cf5
View
@@ -25,9 +25,10 @@ Patch submission guidelines
which category your change falls in, just ask on IRC or the mailing list --
it's often a judgement call.
* **Make sure documentation is updated** -- at the very least, keep docstrings
- current, and if necessary, update the ReST documentation in ``docs/``. For
- example, new ``env.*`` settings should be added to ``docs/usage/env.rst``.
-* **Add a changelog entry** at the top of ``docs/changelog.rst`` following
+ current, and if necessary, update the ReST documentation in ``sites/docs/``.
+ For example, new ``env.*`` settings should be added to
+ ``sites/docs/usage/env.rst``.
+* **Add a changelog entry** at the top of ``sites/www/changelog.rst`` following
existing entries' styles. Don't forget to attribute yourself if you'd like
credit!
View
@@ -1,2 +1,2 @@
For installation help, please see http://fabfile.org/ or (if using a source
-checkout) docs/installation.rst.
+checkout) sites/www/installation.rst.
View
@@ -2,8 +2,9 @@ include AUTHORS
include INSTALL
include LICENSE
include README.rst
-recursive-include docs *
-recursive-exclude docs/_build *
+recursive-include sites *
+recursive-exclude sites/docs/_build *
+recursive-exclude sites/www/_build *
include requirements.txt
recursive-include tests *
recursive-exclude tests *.pyc *.pyo
View
@@ -1,88 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
-
-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 " 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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @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 _build/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
- @echo
- @echo "Build finished. The HTML pages are in _build/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in _build/dirhtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in _build/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in _build/qthelp, like this:"
- @echo "# qcollectiongenerator _build/qthelp/Fabric.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile _build/qthelp/Fabric.qhc"
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
- @echo
- @echo "Build finished; the LaTeX files are in _build/latex."
- @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
- "run these through (pdf)latex."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
- @echo
- @echo "The overview file is in _build/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in _build/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in _build/doctest/output.txt."
Oops, something went wrong.

0 comments on commit 6f8049a

Please sign in to comment.