Skip to content

Commit 1b4fc88

Browse files
author
Zearin
committed
dev/env.rst: Markup
1 parent c06fca1 commit 1b4fc88

File tree

1 file changed

+32
-22
lines changed

1 file changed

+32
-22
lines changed

docs/dev/env.rst

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Vim is a text editor which uses keyboard shortcuts for editing instead of menus
1616
or icons. There exist a couple of plugins and settings for the VIM editor to
1717
aid Python development. If you only develop in Python, a good start is to set
1818
the default settings for indentation and line-wrapping to values compliant with
19-
:pep:`8`. In your home directory, open a file called `.vimrc` and add the
19+
:pep:`8`. In your home directory, open a file called ``.vimrc`` and add the
2020
following lines::
2121

2222
set textwidth=79 " lines longer than 79 columns will be broken
@@ -42,11 +42,11 @@ If your VIM is compiled with `+python` you can also utilize some very handy
4242
plugins to do these checks from within the editor.
4343

4444
For PEP8 checking, install the vim-pep8_ plugin, and for pyflakes you can
45-
install vim-pyflakes_. Now you can map the functions `Pep8()` or `Pyflakes()`
45+
install vim-pyflakes_. Now you can map the functions ``Pep8()`` or ``Pyflakes()``
4646
to any hotkey or action you want in Vim. Both plugins will display errors at
4747
the bottom of the screen, and provide an easy way to jump to the corresponding
4848
line. It's very handy to call these functions whenever you save a file. In
49-
order to do this, add the following lines to your `vimrc`::
49+
order to do this, add the following lines to your ``.vimrc``::
5050

5151
autocmd BufWritePost *.py call Pyflakes()
5252
autocmd BufWritePost *.py call Pep8()
@@ -67,12 +67,12 @@ Python-mode
6767
Python-mode_ is a complex solution in VIM for working with Python code.
6868
It has:
6969

70-
- Asynchronous Python code checking (pylint, pyflakes, pep8, mccabe) in any combination
70+
- Asynchronous Python code checking (``pylint``, ``pyflakes``, ``pep8``, ``mccabe``) in any combination
7171
- Code refactoring and autocompletion with Rope
7272
- Fast Python folding
7373
- Virtualenv support
7474
- Search by Python documentation and run Python code
75-
- Auto PEP8 error fixes
75+
- Auto PEP8_ error fixes
7676

7777
And more.
7878

@@ -105,10 +105,10 @@ already an Emacs user is `Python Programming in Emacs`_ at EmacsWiki.
105105
TextMate
106106
--------
107107

108-
"`TextMate <http://macromates.com/>`_ brings Apple's approach to operating
109-
systems into the world of text editors. By bridging UNIX underpinnings and GUI,
110-
TextMate cherry-picks the best of both worlds to the benefit of expert
111-
scripters and novice users alike."
108+
`TextMate <http://macromates.com/>`_ brings Apple's approach to operating
109+
systems into the world of text editors. By bridging UNIX underpinnings and GUI,
110+
TextMate cherry-picks the best of both worlds to the benefit of expert
111+
scripters and novice users alike.
112112

113113
Sublime Text
114114
------------
@@ -189,18 +189,22 @@ virtualenv
189189
Virtualenv is a tool to keep the dependencies required by different projects
190190
in separate places, by creating virtual Python environments for them.
191191
It solves the "Project X depends on version 1.x but, Project Y needs 4.x"
192-
dilemma and keeps your global site-packages directory clean and manageable.
192+
dilemma, and keeps your global ``site-packages`` directory clean and manageable.
193193

194194
`virtualenv <http://www.virtualenv.org/en/latest/index.html>`_ creates
195195
a folder which contains all the necessary executables to contain the
196196
packages that a Python project would need. An example workflow is given.
197197

198-
Install virtualenv::
198+
Install virtualenv:
199+
200+
.. code-block:: console
199201
200202
$ pip install virtualenv
201203
202204
203-
Create a virtual environment for a project::
205+
Create a virtual environment for a project:
206+
207+
.. code-block:: console
204208
205209
$ cd my_project
206210
$ virtualenv venv
@@ -211,16 +215,22 @@ library which you can use to install other packages. The name of the
211215
virtual environment (in this case, it was ``venv``) can be anything;
212216
omitting the name will place the files in the current directory instead.
213217

214-
To start using the virtual environment, run::
218+
To start using the virtual environment, run:
219+
220+
.. code-block:: console
215221
216222
$ source venv/bin/activate
217223
218224
219225
The name of the current virtual environment will now appear on the left
220226
of the prompt (e.g. ``(venv)Your-Computer:your_project UserName$``) to
221227
let you know that it's active. From now on, any package that you install
222-
using ``pip`` will be placed in the venv folder, isolated from the global
223-
Python installation. Install packages as usual::
228+
using ``pip`` will be placed in the ``venv`` folder, isolated from the global
229+
Python installation.
230+
231+
Install packages as usual:
232+
233+
.. code-block:: console
224234
225235
$ pip install requests
226236
@@ -239,7 +249,7 @@ for keeping the package list clean in case it needs to be accessed later.
239249
In order to keep your environment consistent, it's a good idea to "freeze"
240250
the current state of the environment packages. To do this, run
241251

242-
::
252+
.. code-block:: console
243253
244254
$ pip freeze > requirements.txt
245255
@@ -249,7 +259,7 @@ versions. Later, when a different developer (or you, if you need to re-
249259
create the environment) can install the same packages, with the same
250260
versions by running
251261

252-
::
262+
.. code-block:: console
253263
254264
$ pip install -r requirements.txt
255265
@@ -265,14 +275,14 @@ virtualenvwrapper
265275
`Virtualenvwrapper <http://pypi.python.org/pypi/virtualenvwrapper>`_ makes
266276
virtualenv a pleasure to use by wrapping the command line API with a nicer CLI.
267277

268-
::
278+
.. code-block:: console
269279
270280
$ pip install virtualenvwrapper
271281
272282
273-
Put this into your `~/.bash_profile` (Linux/Mac) file:
283+
Put this into your ``~/.bash_profile`` (Linux/Mac) file:
274284

275-
::
285+
.. code-block:: console
276286
277287
$ export VIRTUALENVWRAPPER_VIRTUALENV_ARGS='--no-site-packages'
278288
@@ -312,7 +322,7 @@ most out of using Python interactively. Its main components are:
312322
* Flexible, embeddable interpreters to load into your own projects.
313323
* Tools for high level and interactive parallel computing.
314324

315-
::
325+
.. code-block:: console
316326
317327
$ pip install ipython
318328
@@ -333,7 +343,7 @@ Python interpreter for Unix-like operating systems. It has the following feature
333343
* Auto-indentation.
334344
* Python 3 support.
335345

336-
::
346+
.. code-block:: console
337347
338348
$ pip install bpython
339349

0 commit comments

Comments
 (0)