summaryrefslogtreecommitdiff
path: root/doc/source/developing.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/developing.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/developing.rst')
-rw-r--r--doc/source/developing.rst209
1 files changed, 0 insertions, 209 deletions
diff --git a/doc/source/developing.rst b/doc/source/developing.rst
deleted file mode 100644
index 2981ba4d..00000000
--- a/doc/source/developing.rst
+++ /dev/null
@@ -1,209 +0,0 @@
-===============================
-Developing with OpenStackClient
-===============================
-
-Communication
--------------
-
-Meetings
-========
-The OpenStackClient team meets regularly on every Thursday. For details
-please refer to the `OpenStack IRC meetings`_ page.
-
-.. _`OpenStack IRC meetings`: http://eavesdrop.openstack.org/#OpenStackClient_Team_Meeting
-
-Testing
--------
-
-Tox prerequisites and installation
-==================================
-
-Install the prerequisites for Tox:
-
-* On Ubuntu or Debian:
-
- .. code-block:: bash
-
- $ apt-get install gcc gettext python-dev libxml2-dev libxslt1-dev \
- zlib1g-dev
-
- You may need to use pip install for some packages.
-
-
-* On RHEL or CentOS including Fedora:
-
- .. code-block:: bash
-
- $ yum install gcc python-devel libxml2-devel libxslt-devel
-
-* On openSUSE or SUSE linux Enterprise:
-
- .. code-block:: bash
-
- $ zypper install gcc python-devel libxml2-devel libxslt-devel
-
-Install python-tox:
-
-.. code-block:: bash
-
- $ pip install tox
-
-To run the full suite of tests maintained within OpenStackClient.
-
-.. code-block:: bash
-
- $ tox
-
-.. NOTE::
-
- The first time you run ``tox``, it will take additional time to build
- virtualenvs. You can later use the ``-r`` option with ``tox`` to rebuild
- your virtualenv in a similar manner.
-
-
-To run tests for one or more specific test environments(for example, the most common configuration of
-Python 2.7 and PEP-8), list the environments with the ``-e`` option, separated by spaces:
-
-.. code-block:: bash
-
- $ tox -e py27,pep8
-
-See ``tox.ini`` for the full list of available test environments.
-
-Running functional tests
-========================
-
-OpenStackClient also maintains a set of functional tests that are optimally
-designed to be run against OpenStack's gate. Optionally, a developer may
-choose to run these tests against any OpenStack deployment, however depending
-on the services available, results vary.
-
-To run the entire suite of functional tests:
-
-.. code-block:: bash
-
- $ tox -e functional
-
-To run a specific functional test:
-
-.. code-block:: bash
-
- $ tox -e functional -- --regex functional.tests.compute.v2.test_server
-
-Running with PDB
-================
-
-Using PDB breakpoints with ``tox`` and ``testr`` normally does not work since
-the tests fail with a `BdbQuit` exception rather than stopping at the
-breakpoint.
-
-To run with PDB breakpoints during testing, use the `debug` ``tox`` environment
-rather than ``py27``. For example, passing a test name since you will normally
-only want to run the test that hits your breakpoint:
-
-.. code-block:: bash
-
- $ tox -e debug openstackclient.tests.identity.v3.test_group
-
-For reference, the `debug`_ ``tox`` environment implements the instructions
-
-.. _`debug`: https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests
-
-
-Building the Documentation
---------------------------
-
-The documentation is generated with Sphinx using the ``tox`` command. To
-create HTML docs, run the commands:
-
-.. code-block:: bash
-
- $ tox -e docs
-
-The resultant HTML will be in the ``doc/build/html`` directory.
-
-Release Notes
--------------
-
-The release notes for a patch should be included in the patch. See the
-`Project Team Guide`_ for more information on using reno in OpenStack.
-
-.. _`Project Team Guide`: http://docs.openstack.org/project-team-guide/release-management.html#managing-release-notes
-
-If any of the following applies to the patch, a release note is required:
-
-* The deployer needs to take an action when upgrading
-* The plugin interface changes
-* A new feature is implemented
-* A command or option is removed
-* Current behavior is changed
-* A security bug is fixed
-
-Reno is used to generate release notes. Use the commands:
-
-.. code-block:: bash
-
- $ tox -e venv -- reno new <bug-,bp-,whatever>
-
-Then edit the sample file that was created and push it with your change.
-
-To run the commands and see results:
-
-.. code-block:: bash
-
- $ git commit # Commit the change because reno scans git log.
-
- $ tox -e releasenotes
-
-At last, look at the generated release notes files in ``releasenotes/build/html`` in your browser.
-
-Testing new code
-----------------
-
-If a developer wants to test new code (feature, command or option) that
-they have written, OpenStackClient may be installed from source by running
-the following commands in the base directory of the project:
-
-.. code-block:: bash
-
- $ python setup.py develop
-
-or
-
-.. code-block:: bash
-
- $ pip install -e .
-
-Standardize Import Format
-=========================
-
-.. _`Import Order Guide`: http://docs.openstack.org/developer/hacking/#imports
-
-The import order shows below:
-
-* {{stdlib imports in human alphabetical order}}
-* \n
-* {{third-party lib imports in human alphabetical order}}
-* \n
-* {{project imports in human alphabetical order}}
-* \n
-* \n
-* {{begin your code}}
-
-Example
-~~~~~~~
-
-.. code-block:: python
-
- import copy
- import fixtures
- import mock
- import os
-
- from osc_lib.api import auth
- from osc_lib import utils
- import six
-
- from openstackclient import shell
- from openstackclient.tests import utils
-