Skip to content

Commit

Permalink
Adding documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Steven Arcangeli committed Jan 14, 2014
1 parent b98c88c commit b2f42f1
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 4 deletions.
11 changes: 9 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
Pyramid Duh
===========
:Build: |build|_ |coverage|_
:Documentation: http://pyramid_duh.readthedocs.org/en/latest/
:Master Build: |build|_ |coverage|_
:0.1 Build: |build-0.1|_ |coverage-0.1|_
:Documentation: http://pyramid_duh.readthedocs.org/
:Downloads: http://pypi.python.org/pypi/pyramid_duh
:Source: https://github.com/stevearc/pyramid_duh

.. |build| image:: https://travis-ci.org/stevearc/pyramid_duh.png?branch=master
.. _build: https://travis-ci.org/stevearc/pyramid_duh
.. |coverage| image:: https://coveralls.io/repos/stevearc/pyramid_duh/badge.png?branch=master
.. _coverage: https://coveralls.io/r/stevearc/pyramid_duh?branch=master

.. |build-0.1| image:: https://travis-ci.org/stevearc/pyramid_duh.png?branch=0.1
.. _build-0.1: https://travis-ci.org/stevearc/pyramid_duh
.. |coverage-0.1| image:: https://coveralls.io/repos/stevearc/pyramid_duh/badge.png?branch=0.1
.. _coverage-0.1: https://coveralls.io/r/stevearc/pyramid_duh?branch=0.1

This is just a collection of utilities that I found myself putting into *every
single* pyramid project I made. So now they're all in one place.
1 change: 1 addition & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ clean:
apidoc:
$(SPHINXAPIDOC) -f -e -o $(APIDIR) ../pyramid_duh
rm -f $(APIDIR)/*.tests.*
cp ../CHANGES.rst changes.rst
@echo
@echo "Build finished. The RST files are in $(APIDIR)."

Expand Down
3 changes: 3 additions & 0 deletions doc/changes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
0.1.0
-----
* Package released into the wild
38 changes: 37 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Pyramid Duh - Tools you Want
============================

This is just a collection of utilities that I found myself putting into *every
single* pyramid project I made. So now they're all in one place.

User Guide
----------

.. toctree::
:maxdepth: 1
:glob:
Expand All @@ -11,6 +17,27 @@ Pyramid Duh - Tools you Want
topics/subpath
topics/settings

Versions
--------
========= =============== ========
Version Build Coverage
========= =============== ========
master_ |build-master|_ |coverage-master|_
0.1.0_ |build-0.1.0|_ |coverage-0.1.0|_
========= =============== ========

.. _master: ../latest/
.. |build-master| image:: https://travis-ci.org/stevearc/pyramid_duh.png?branch=master
.. _build-master: https://travis-ci.org/stevearc/pyramid_duh
.. |coverage-master| image:: https://coveralls.io/repos/stevearc/pyramid_duh/badge.png?branch=master
.. _coverage-master: https://coveralls.io/r/stevearc/pyramid_duh?branch=master

.. _0.1.0: ../0.1.0/
.. |build-0.1.0| image:: https://travis-ci.org/stevearc/pyramid_duh.png?branch=0.1.0
.. _build-0.1.0: https://travis-ci.org/stevearc/pyramid_duh
.. |coverage-0.1.0| image:: https://coveralls.io/repos/stevearc/pyramid_duh/badge.png?branch=0.1.0
.. _coverage-0.1.0: https://coveralls.io/r/stevearc/pyramid_duh?branch=0.1.0

API Reference
-------------
.. toctree::
Expand All @@ -19,8 +46,17 @@ API Reference

ref/pyramid_duh

Changelog
---------

.. toctree::
:maxdepth: 1
:glob:

changes

Indices and tables
==================
------------------

* :ref:`genindex`
* :ref:`modindex`
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
],
author='Steven Arcangeli',
author_email='arcangeli07@gmail.com',
url='http://github.com/stevearc/pyramid_duh',
url='http://pyramid-duh.readthedocs.org/',
keywords='pyramid util utility',
license='MIT',
zip_safe=False,
Expand Down

0 comments on commit b2f42f1

Please sign in to comment.