Skip to content

Commit c24c642

Browse files
committed
Include pipenv section and clean up document based on doc8
1 parent af166dd commit c24c642

File tree

1 file changed

+49
-4
lines changed

1 file changed

+49
-4
lines changed

doc/developing.rst

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ using ``$ tmux -L test_case``.
2222
Install the latest code from git
2323
--------------------------------
2424

25+
Using pip
26+
^^^^^^^^^
27+
2528
To begin developing, check out the code from github:
2629

2730
.. code-block:: bash
@@ -56,6 +59,48 @@ adjust the code and the installed software will reflect the changes.
5659
5760
$ tmuxp
5861
62+
Using pipenv
63+
^^^^^^^^^^^^
64+
65+
To begin developing, check out the code from github:
66+
67+
.. code-block:: bash
68+
69+
$ git clone git@github.com:tmux-python/tmuxp.git
70+
$ cd tmuxp
71+
72+
You can create a virtualenv, and install all of the locked
73+
packages as listed in Pipfile.lock:
74+
75+
.. code-block:: bash
76+
77+
$ pipenv install --ignore-pipfile --dev
78+
79+
If you prefer to install updated packages based on Pipfile only, not being
80+
bound by Pipfile.lock:
81+
82+
.. code-block:: bash
83+
84+
$ pipenv install --skip-lock --dev
85+
86+
If you ever need to update packages during your development session, the
87+
following command can be used to update all packages as per Pipfile settings or
88+
individual package (second command):
89+
90+
.. code-block:: bash
91+
92+
$ pipenv update --dev
93+
$ pipenv update requests
94+
95+
Then activate it to your current tty / terminal session with:
96+
97+
.. code-block:: bash
98+
99+
$ pipenv shell
100+
101+
That is it! You are now ready to code!
102+
103+
59104
Test Runner
60105
-----------
61106

@@ -76,7 +121,7 @@ If you found a problem or are trying to write a test, you can file an
76121
.. _test_specific_tests:
77122

78123
Test runner options
79-
~~~~~~~~~~~~~~~~~~~
124+
^^^^^^^^^^^^^^^^^^^
80125

81126
Test only a file:
82127

@@ -114,7 +159,7 @@ Create two terminals:
114159
version of tmuxp above. Then:
115160

116161
.. code-block:: bash
117-
162+
118163
$ py.test tests/test_workspacebuilder.py
119164
120165
Terminal 1 should have flickered and built the session before your eyes.
@@ -147,7 +192,7 @@ argument`_:
147192
$ make watch_test test='-x tests/test_config.py tests/test_util.py'
148193
149194
Rebuild sphinx docs on save
150-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
195+
---------------------------
151196

152197
Rebuild the documentation when an ``.rst`` file is edited:
153198

@@ -178,7 +223,7 @@ this will load the ``.tmuxp.yaml`` in the root of the project.
178223
.. _travis:
179224

180225
Travis CI
181-
~~~~~~~~~
226+
---------
182227

183228
tmuxp uses `travis-ci`_ for continuous integration / automatic unit
184229
testing.

0 commit comments

Comments
 (0)