diff options
| author | Gary W. Smith <gary.w.smith@hp.com> | 2014-05-07 12:59:38 -0700 |
|---|---|---|
| committer | Gary W. Smith <gary.w.smith@hp.com> | 2014-05-09 18:22:50 +0000 |
| commit | 628e908a3dc3d66488a2f65cc5f3a1865f7859b1 (patch) | |
| tree | f906f0fce6dc21060a7028c25645bd71535365a8 /README.rst | |
| parent | 37f24263371057d9a4a7dd342beec247da862f47 (diff) | |
| download | horizon-628e908a3dc3d66488a2f65cc5f3a1865f7859b1.tar.gz | |
Fix build instructions and formatting in README
- 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
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/README.rst b/README.rst index 68b7ea758..9bda3d97b 100644 --- a/README.rst +++ b/README.rst @@ -25,7 +25,7 @@ Getting Started =============== 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 @@ -38,9 +38,9 @@ environment. To do this, create a ``local_settings.py`` file in the ``openstack_dashboard/local/`` directory. There is a ``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:: @@ -91,11 +91,11 @@ Building Contributor Documentation 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: http://docutils.sourceforge.net/rst.html -.. _Sphinx: http://sphinx.pocoo.org/ +.. _Sphinx: http://sphinx-doc.org/ * Building Automatically:: @@ -103,8 +103,6 @@ The source is maintained in the ``doc/source`` folder using * Building Manually:: - $ export DJANGO_SETTINGS_MODULE=local.local_settings - $ python doc/generate_autodoc_index.py - $ sphinx-build -b html doc/source build/sphinx/html + $ tools/with_venv.sh sphinx-build doc/source doc/build/html -Results are in the `build/sphinx/html` directory +Results are in the ``doc/build/html`` directory |