openstack/openstack-manuals
Code Issues Proposed changes

Merge "[contributor] Fix docs-builds rendering"

Browse Source
This commit is contained in:
Jenkins 2017-09-07 14:24:19 +00:00 committed by Gerrit Code Review
commit fae8369eef
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/contributor-guide/source/docs-builds.rst
View File

@ -10,17 +10,17 @@ Clone a repository first
Before building documentation, you must first clone the repo where the files Before building documentation, you must first clone the repo where the files
reside: reside:
.. code-block:: console .. code-block:: console
$ git clone git://git.openstack.org/openstack/openstack-manuals.git $ git clone git://git.openstack.org/openstack/openstack-manuals.git
Navigate to the ``openstack-manuals`` directory and create a branch from there Navigate to the ``openstack-manuals`` directory and create a branch from there
to do your work: to do your work:
.. code-block:: console .. code-block:: console
$ cd openstack-manuals $ cd openstack-manuals
$ git checkout -b new-branch $ git checkout -b new-branch
The value of ``new-branch`` is any name you want to give to your branch. The value of ``new-branch`` is any name you want to give to your branch.
@ -66,10 +66,10 @@ Open a Terminal window. Make sure you have Python installed. Many contributors
use the `Homebrew tool instructions use the `Homebrew tool instructions
<http://python-guide-pt-br.readthedocs.io/en/latest/starting/install/osx/>`_. <http://python-guide-pt-br.readthedocs.io/en/latest/starting/install/osx/>`_.
.. code-block:: console .. code-block:: console
$ brew install python $ brew install python
$ pip install tox $ pip install tox
* On Ubuntu or Debian: * On Ubuntu or Debian:
@ -111,9 +111,9 @@ To the doc build scripts as-is on Windows, first install `Git for Windows`_.
Make sure you have a working Python environment, and then use Git Bash to run Make sure you have a working Python environment, and then use Git Bash to run
all :command:`tox` commands within the repository directory: all :command:`tox` commands within the repository directory:
.. code-block:: console .. code-block:: console
$ pip install tox $ pip install tox
.. _Git for Windows: https://git-for-windows.github.io/ .. _Git for Windows: https://git-for-windows.github.io/