openstack/horizon
Code Issues Proposed changes

Fix build instructions and formatting in README

Browse Source 
- Fix manual build command
- Fix formatting of command-line examples, directory names
- Rename 'folder' to 'directory' for consistency
- Update sphinx URL

Partial-bug: #1257725
Change-Id: I078bc5b9c931d4bf4e57c8fe7b335db99cc92c29
This commit is contained in:
Gary W. Smith 2014-05-07 12:59:38 -07:00
parent 37f2426337
commit 628e908a3d
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -25,7 +25,7 @@ Getting Started
=============== ===============
For local development, first create a virtualenv for the project. For local development, first create a virtualenv for the project.
In the ``tools`` directory there is a script to create one for you: In the ``tools`` directory there is a script to create one for you::
$ python tools/install_venv.py $ python tools/install_venv.py
@ -38,9 +38,9 @@ environment. To do this, create a ``local_settings.py`` file in the
``openstack_dashboard/local/`` directory. There is a ``openstack_dashboard/local/`` directory. There is a
``local_settings.py.example`` file there that may be used as a template. ``local_settings.py.example`` file there that may be used as a template.
If all is well you should able to run the development server locally: If all is well you should able to run the development server locally::
$ tools/with_venv.sh manage.py runserver $ tools/with_venv.sh ./manage.py runserver
or, as a shortcut:: or, as a shortcut::
@ -91,11 +91,11 @@ Building Contributor Documentation
This documentation is written by contributors, for contributors. This documentation is written by contributors, for contributors.
The source is maintained in the ``doc/source`` folder using The source is maintained in the ``doc/source`` directory using
`reStructuredText`_ and built by `Sphinx`_ `reStructuredText`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/ .. _Sphinx: http://sphinx-doc.org/
* Building Automatically:: * Building Automatically::
@ -103,8 +103,6 @@ The source is maintained in the ``doc/source`` folder using
* Building Manually:: * Building Manually::
$ export DJANGO_SETTINGS_MODULE=local.local_settings $ tools/with_venv.sh sphinx-build doc/source doc/build/html
$ python doc/generate_autodoc_index.py
$ sphinx-build -b html doc/source build/sphinx/html
Results are in the `build/sphinx/html` directory Results are in the ``doc/build/html`` directory