Basic docs structure

palewire · May 10, 2015 · 5827590 · 5827590
1 parent e2a4b16
commit 5827590
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 15 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,4 @@
+.PHONY: docs
+
+docs:
+	cd docs && make livehtml
diff --git a/docs/Makefile b/docs/Makefile
@@ -56,6 +56,9 @@ html:
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+livehtml:
+	sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo

diff --git a/docs/genericviews.rst b/docs/genericviews.rst
@@ -0,0 +1,2 @@
+Generic views
+=============
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
@@ -0,0 +1,2 @@
+Getting started
+===============
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,22 +1,19 @@
-.. django-memento-framework documentation master file, created by
-   sphinx-quickstart on Sat May  9 19:50:33 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+django-memento-framework
+========================
 
-Welcome to django-memento-framework's documentation!
-====================================================
+A set for helpers for Django web sites to enable the Memento framework for time-based access
 
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
+   gettingstarted
+   genericviews
+   changelog
 
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
+* Code repository: `https://github.com/pastpages/django-memento-framework <https://github.com/pastpages/django-memento-framework>`_
+* Issues: `https://github.com/pastpages/django-memento-framework/issues <https://github.com/pastpages/django-memento-framework/issues>`_
+* Packaging: `https://pypi.python.org/pypi/django-memento-framework <https://pypi.python.org/pypi/django-memento-framework>`_
+* Testing: `https://travis-ci.org/pastpages/django-memento-framework <https://travis-ci.org/pastpages/django-memento-framework>`_
+* Coverage: `https://coveralls.io/r/pastpages/django-memento-framework <https://coveralls.io/r/pastpages/django-memento-framework>`_