Commit e4f39a4d authored by Ashish's avatar Ashish
Browse files

RTD updates - go baby

parent 788f0a0b
......@@ -3,7 +3,7 @@ Contributing
============
Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.
little bit helps, and credit will always be given.
You can contribute in many ways:
......@@ -13,7 +13,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~
Report bugs at https://github.com/iagore/djangorest-alchemy/issues.
Report bugs at https://github.com/Dealertrack/djangorest-alchemy/issues.
If you are reporting a bug, please include:
......@@ -36,14 +36,14 @@ is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~
djangorest-alchemy could always use more documentation, whether as part of the
djangorest-alchemy could always use more documentation, whether as part of the
official djangorest-alchemy docs, in docstrings, or even on the web in blog posts,
articles, and such.
Submit Feedback
~~~~~~~~~~~~~~~
The best way to send feedback is to file an issue at https://github.com/iagore/djangorest-alchemy/issues.
The best way to send feedback is to file an issue at https://github.com/Dealertrack/djangorest-alchemy/issues.
If you are proposing a feature:
......@@ -71,7 +71,7 @@ Ready to contribute? Here's how to set up `djangorest-alchemy` for local develop
4. Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
......@@ -80,7 +80,7 @@ Ready to contribute? Here's how to set up `djangorest-alchemy` for local develop
$ python setup.py test
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
To get flake8 and tox, just pip install them into your virtualenv.
6. Commit your changes and push your branch to GitHub::
......@@ -99,13 +99,6 @@ Before you submit a pull request, check that it meets these guidelines:
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
https://travis-ci.org/iagore/djangorest-alchemy/pull_requests
and make sure that the tests pass for all supported Python versions.
Tips
----
To run a subset of tests::
$ python -m unittest tests.test_djangorest-alchemy
\ No newline at end of file
......@@ -3,7 +3,7 @@
History
-------
0.1.0 (2014-01-11)
0.1.0 (2014-09-03)
++++++++++++++++++
* First release on PyPI.
\ No newline at end of file
* First release
\ No newline at end of file
djangorest_alchemy package
==========================
Subpackages
-----------
.. toctree::
djangorest_alchemy.tests
Submodules
----------
djangorest_alchemy.fields module
--------------------------------
.. automodule:: djangorest_alchemy.fields
:members:
:undoc-members:
:show-inheritance:
djangorest_alchemy.inspector module
-----------------------------------
.. automodule:: djangorest_alchemy.inspector
:members:
:undoc-members:
:show-inheritance:
djangorest_alchemy.managers module
----------------------------------
.. automodule:: djangorest_alchemy.managers
:members:
:undoc-members:
:show-inheritance:
djangorest_alchemy.mixins module
--------------------------------
.. automodule:: djangorest_alchemy.mixins
:members:
:undoc-members:
:show-inheritance:
djangorest_alchemy.routers module
---------------------------------
.. automodule:: djangorest_alchemy.routers
:members:
:undoc-members:
:show-inheritance:
djangorest_alchemy.serializers module
-------------------------------------
.. automodule:: djangorest_alchemy.serializers
:members:
:undoc-members:
:show-inheritance:
djangorest_alchemy.settings module
----------------------------------
.. automodule:: djangorest_alchemy.settings
:members:
:undoc-members:
:show-inheritance:
djangorest_alchemy.viewsets module
----------------------------------
.. automodule:: djangorest_alchemy.viewsets
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: djangorest_alchemy
:members:
:undoc-members:
:show-inheritance:
API Documentation
==================
.. toctree::
:maxdepth: 4
djangorest_alchemy
\ No newline at end of file
......@@ -16,6 +16,8 @@
import sys
import os
os.environ['DJANGO_SETTINGS_MODULE'] = 'djangorest_alchemy.settings'
# 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 documentation root, use os.path.abspath to make it
......@@ -31,7 +33,6 @@ project_root = os.path.dirname(cwd)
# version is used.
sys.path.insert(0, project_root)
import djangorest-alchemy
# -- General configuration ---------------------------------------------
......@@ -55,7 +56,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'djangorest-alchemy'
project = u'djangorest_alchemy'
copyright = u'2014, Ashish Gore'
# The version info for the project you're documenting, acts as replacement
......@@ -63,9 +64,9 @@ copyright = u'2014, Ashish Gore'
# the built documents.
#
# The short X.Y version.
version = djangorest-alchemy.__version__
version = '0.1.0'
# The full version, including alpha/beta/rc tags.
release = djangorest-alchemy.__version__
release = '0.1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -188,7 +189,7 @@ html_static_path = ['_static']
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'djangorest-alchemydoc'
htmlhelp_basename = 'djangorest_alchemydoc'
# -- Options for LaTeX output ------------------------------------------
......@@ -208,8 +209,8 @@ latex_elements = {
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'djangorest-alchemy.tex',
u'djangorest-alchemy Documentation',
('index', 'djangorest_alchemy.tex',
u'djangorest_alchemy Documentation',
u'Ashish Gore', 'manual'),
]
......@@ -239,8 +240,8 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'djangorest-alchemy',
u'djangorest-alchemy Documentation',
('index', 'djangorest_alchemy',
u'djangorest_alchemy Documentation',
[u'Ashish Gore'], 1)
]
......@@ -254,10 +255,10 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'djangorest-alchemy',
u'djangorest-alchemy Documentation',
('index', 'djangorest_alchemy',
u'djangorest_alchemy Documentation',
u'Ashish Gore',
'djangorest-alchemy',
'djangorest_alchemy',
'One line description of project.',
'Miscellaneous'),
]
......@@ -272,4 +273,4 @@ texinfo_documents = [
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
\ No newline at end of file
#texinfo_no_detailmenu = False
......@@ -17,6 +17,7 @@ Contents:
contributing
authors
history
api/modules
Indices and tables
==================
......
.. include:: ../README.rst
\ No newline at end of file
.. include:: ../README.md
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment