Skip to content

Commit 628e908

Browse files
author
Gary W. Smith
committed
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
1 parent 37f2426 commit 628e908

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.rst

+7-9
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Getting Started
2525
===============
2626

2727
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::
2929

3030
$ python tools/install_venv.py
3131

@@ -38,9 +38,9 @@ environment. To do this, create a ``local_settings.py`` file in the
3838
``openstack_dashboard/local/`` directory. There is a
3939
``local_settings.py.example`` file there that may be used as a template.
4040

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::
4242

43-
$ tools/with_venv.sh manage.py runserver
43+
$ tools/with_venv.sh ./manage.py runserver
4444

4545
or, as a shortcut::
4646

@@ -91,20 +91,18 @@ Building Contributor Documentation
9191

9292
This documentation is written by contributors, for contributors.
9393

94-
The source is maintained in the ``doc/source`` folder using
94+
The source is maintained in the ``doc/source`` directory using
9595
`reStructuredText`_ and built by `Sphinx`_
9696

9797
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
98-
.. _Sphinx: http://sphinx.pocoo.org/
98+
.. _Sphinx: http://sphinx-doc.org/
9999

100100
* Building Automatically::
101101

102102
$ ./run_tests.sh --docs
103103

104104
* Building Manually::
105105

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
109107

110-
Results are in the `build/sphinx/html` directory
108+
Results are in the ``doc/build/html`` directory

0 commit comments

Comments
 (0)