Browse Source

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
tags/2014.2.b1
Gary W. Smith 5 years ago
parent
commit
628e908a3d
1 changed files with 7 additions and 9 deletions
  1. 7
    9
      README.rst

+ 7
- 9
README.rst View File

@@ -25,7 +25,7 @@ Getting Started
25 25
 ===============
26 26
 
27 27
 For local development, first create a virtualenv for the project.
28
-In the ``tools`` directory there is a script to create one for you:
28
+In the ``tools`` directory there is a script to create one for you::
29 29
 
30 30
   $ python tools/install_venv.py
31 31
 
@@ -38,9 +38,9 @@ environment.  To do this, create a ``local_settings.py`` file in the
38 38
 ``openstack_dashboard/local/`` directory.  There is a
39 39
 ``local_settings.py.example`` file there that may be used as a template.
40 40
 
41
-If all is well you should able to run the development server locally:
41
+If all is well you should able to run the development server locally::
42 42
 
43
-  $ tools/with_venv.sh manage.py runserver
43
+  $ tools/with_venv.sh ./manage.py runserver
44 44
 
45 45
 or, as a shortcut::
46 46
 
@@ -91,11 +91,11 @@ Building Contributor Documentation
91 91
 
92 92
 This documentation is written by contributors, for contributors.
93 93
 
94
-The source is maintained in the ``doc/source`` folder using
94
+The source is maintained in the ``doc/source`` directory using
95 95
 `reStructuredText`_ and built by `Sphinx`_
96 96
 
97 97
 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
98
-.. _Sphinx: http://sphinx.pocoo.org/
98
+.. _Sphinx: http://sphinx-doc.org/
99 99
 
100 100
 * Building Automatically::
101 101
 
@@ -103,8 +103,6 @@ The source is maintained in the ``doc/source`` folder using
103 103
 
104 104
 * Building Manually::
105 105
 
106
-    $ export DJANGO_SETTINGS_MODULE=local.local_settings
107
-    $ python doc/generate_autodoc_index.py
108
-    $ sphinx-build -b html doc/source build/sphinx/html
106
+    $ tools/with_venv.sh sphinx-build doc/source doc/build/html
109 107
 
110
-Results are in the `build/sphinx/html` directory
108
+Results are in the ``doc/build/html`` directory

Loading…
Cancel
Save