mirror of
https://github.com/ets-labs/python-dependency-injector.git
synced 2024-11-22 01:26:51 +03:00
Adding installation doc
This commit is contained in:
parent
bab92a58ae
commit
bbc5e83e07
11
docs/conf.py
11
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'),
|
||||
]
|
||||
|
||||
|
|
5
docs/examples.rst
Normal file
5
docs/examples.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
Examples
|
||||
========
|
||||
|
||||
You can get more `Objects` examples in `/examples` directory on
|
||||
GitHub: https://github.com/rmk135/objects
|
|
@ -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
|
||||
|
|
14
docs/installation.rst
Normal file
14
docs/installation.rst
Normal 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
|
Loading…
Reference in New Issue
Block a user