From bbc5e83e07812e242ab06dbb8008ab17e5fd339c Mon Sep 17 00:00:00 2001 From: Roman Mogilatov Date: Thu, 2 Apr 2015 22:29:49 +0300 Subject: [PATCH] Adding installation doc --- docs/conf.py | 11 ++++++----- docs/examples.rst | 5 +++++ docs/index.rst | 7 ++----- docs/installation.rst | 14 ++++++++++++++ 4 files changed, 27 insertions(+), 10 deletions(-) create mode 100644 docs/examples.rst create mode 100644 docs/installation.rst diff --git a/docs/conf.py b/docs/conf.py index 75115e63..40823824 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,9 +12,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys import os -import shlex # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -55,9 +53,12 @@ author = u'Roman Mogilatov' # built documents. # # The short X.Y version. -version = '0.7.0' +# Getting version. +with open('../VERSION') as version: + version = version.read().strip() + # The full version, including alpha/beta/rc tags. -release = '0.7.0' +release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -278,7 +279,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'Objects', u'Objects Documentation', - author, 'Objects', 'One line description of project.', + author, 'Objects', 'Dependency management tool for Python projects.', 'Miscellaneous'), ] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 00000000..d939f79f --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,5 @@ +Examples +======== + +You can get more `Objects` examples in `/examples` directory on +GitHub: https://github.com/rmk135/objects diff --git a/docs/index.rst b/docs/index.rst index adba534d..feba6b4b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,3 @@ -.. Objects documentation master file, created by - sphinx-quickstart on Wed Apr 1 17:36:06 2015. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Objects ======= @@ -42,5 +37,7 @@ Contents :maxdepth: 2 introduction + installation entities advanced_usage + examples diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 00000000..0f9248d4 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,14 @@ +Installation +============ + +Latest stable version of `Objects` library can be installed from PyPi_: + + pip install objects + +Sources can be cloned from GitHub: https://github.com/rmk135/objects + + git clone https://github.com/rmk135/objects.git + +All `Objects` releases can be found on GitHub: https://github.com/rmk135/objects/releases + +.. _PyPi: https://pypi.python.org/pypi/Objects