ets-labs/python-dependency-injector
1
1
Fork 0
mirror of https://github.com/ets-labs/python-dependency-injector.git synced 2025-06-19 04:53:14 +03:00
Code Issues Packages Projects Releases Wiki Activity

Adding installation doc

Browse Source
This commit is contained in:
Roman Mogilatov 2015-04-02 22:29:49 +03:00
parent bab92a58ae
commit bbc5e83e07
4 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/conf.py
View File

@ -12,9 +12,7 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys
import os import os
import shlex
# If extensions (or modules to document with autodoc) are in another directory, # 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 # add these directories to sys.path here. If the directory is relative to the
@ -55,9 +53,12 @@ author = u'Roman Mogilatov'
# built documents. # built documents.
# #
# The short X.Y version. # 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. # The full version, including alpha/beta/rc tags.
release = '0.7.0' release = version
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -278,7 +279,7 @@ man_pages = [
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'Objects', u'Objects Documentation', (master_doc, 'Objects', u'Objects Documentation',
author, 'Objects', 'One line description of project.', author, 'Objects', 'Dependency management tool for Python projects.',
'Miscellaneous'), 'Miscellaneous'),
] ]

5
docs/examples.rst Normal file
View File

@ -0,0 +1,5 @@
Examples
========
You can get more `Objects` examples in `/examples` directory on
GitHub: https://github.com/rmk135/objects

7
docs/index.rst
View File

@ -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 Objects
======= =======
@ -42,5 +37,7 @@ Contents
:maxdepth: 2 :maxdepth: 2
introduction introduction
installation
entities entities
advanced_usage advanced_usage
examples

14
docs/installation.rst Normal file
View File

@ -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