Skip to content

Commit f851628

Browse files
committed
Update doc section
Signed-off-by: Sebastian Ramacher <sebastian+dev@ramacher.at>
1 parent 5610ed4 commit f851628

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

doc/sphinx/source/contributing.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,17 @@ To run tests:
5151
To build the docs:
5252
------------------
5353

54-
The documentation is included in the regular `bpython` repository so if you did the
55-
previous step your install can support generating and working on the documentation.
56-
57-
Install `sphinx` (or in your current `virtualenv`). And go to the following directory:
54+
The documentation is included in the regular `bpython` repository. After
55+
checking out the `bpython` repository and installing `sphinx` as described in
56+
the previous step, you can run the following command in your checkout of the
57+
repository to build the documentation:
5858

5959
.. code-block:: bash
6060
61-
$ pip install sphinx
62-
$ cd bpython/doc/sphinx/ # assuming you are in the root dir of the bpython project
63-
$ make html
61+
$ make -C doc/sphinx html
6462
65-
Afterwards you can point your browser to `bpython/doc/source/index.html`. Don't forget
66-
to recreate the HTML after you make changes.
63+
Afterwards you can point your browser to `doc/sphinx/build/html/index.html`.
64+
Don't forget to recreate the HTML after you make changes.
6765

6866

6967
To hack on the site or theme

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy