196fd88c4a
As a part of reorganisation of developer docs, removed the best practices documentation and made the subsections in it as overall sections. More renaming and reorganisation will be addressed in the following patches. Change-Id: I21bf8fe3855fd1d441ec3dba342babc90516714d
29 lines
945 B
ReStructuredText
29 lines
945 B
ReStructuredText
..
|
|
Copyright 2011-2012 OpenStack Foundation
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
Building the Documentation
|
|
==========================
|
|
|
|
The documentation is generated with Sphinx using the tox command. To create HTML
|
|
docs and man pages:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ tox -e docs
|
|
|
|
The results are in the ``doc/build/html`` and ``doc/build/man`` directories
|
|
respectively.
|