Skip to content

Commit

Permalink
docs: linting on Travis, dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fozy81 authored and gr2m committed Feb 26, 2017
1 parent 04e6828 commit 00a8e28
Show file tree
Hide file tree
Showing 15 changed files with 1,036 additions and 274 deletions.
166 changes: 0 additions & 166 deletions CODING_STYLE.md

This file was deleted.

98 changes: 0 additions & 98 deletions TRIAGING.md

This file was deleted.

68 changes: 68 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml epub latex latexpdf linkcheck

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 " 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 " linkcheck to check all external links for integrity"

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."

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."

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."

2 changes: 1 addition & 1 deletion docs/about/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ We define simple Hapi plugins for `logging <https://github.com/hoodiehq/hoodie/b
and for `serving the app’s public assets and the Hoodie client <https://github.com/hoodiehq/hoodie/blob/master/server/plugins/public.js>`__.

Once everything is setup, the server is then started at the end of
`cli/start.js <https://github.com/hoodiehq/hoodie/blob/master/cli/start.js>`__
`cli/start.js <https://github.com/hoodiehq/hoodie/blob/master/cli/index.js>`__
and the URL where hoodie is running is logged to the terminal.

Modules
Expand Down
2 changes: 1 addition & 1 deletion docs/about/hoodie-concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ First.

**Offline First means: build your apps without the assumption of
permanent connectivity**. Cache data and apps locally. Build interfaces
that accomodate the offline state elegantly. Design user interactions
that accommodate the offline state elegantly. Design user interactions
that will not break if their train goes into a tunnel. Don't freak out
your users with network error messages or frustrate them with
inaccessible data. **Offline First apps are faster, more robust, more
Expand Down
10 changes: 5 additions & 5 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ The Hoodie Client API
This library, commonly called **Hoodie Client**, is what you'll be
working with on the client side. It consists of:

- `The Hoodie Client API </api/client/hoodie>`__, which has
- `The Hoodie Client API <client/hoodie.html>`__, which has
a couple of useful helpers
- `The account API </api/client/hoodie.account>`__,
- `The account API <client/hoodie.account.html>`__,
which lets you do user authentication, such as signing users up, in
and out
- `The store API </api/client/hoodie.store>`__,
- `The store API <client/hoodie.store.html>`__,
which provides means to store and retrieve data for each individial
user
- `The connectionStatus API </api/client/hoodie.connection-status>`__,
- `The connectionStatus API <client/hoodie.connection-status>`__,
which provides helpers for connectivity.
- `The log API </api/client/hoodie.log>`__, which
- `The log API <client/hoodie.log.html>`__, which
provides a nice API for logging all the things

The Hoodie Server API
Expand Down

0 comments on commit 00a8e28

Please sign in to comment.