Skip to content

Commit

Permalink
Use 'dev' extra requirement on readthedocs. (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
greschd authored Nov 8, 2020
1 parent 57eb315 commit 3dd808e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ python:
- method: pip
path: .
extra_requirements:
- doc
- dev
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ An important way in which new users can contribute is by writing or improving th

To build the documentation locally, you first need to pull the Z2Pack source, and install it (preferrably in a virtualenv) with

pip install -e path_to_z2pack_source[doc]
pip install -e path_to_z2pack_source[dev]

where ``path_to_z2pack_source`` needs to be replaced with the top-level path of the Z2Pack source. In the ``doc`` subfolder, copy the configuration template ``config.mk.tpl`` to ``config.mk``. After that, you can simply call ``make`` to build and ``make view`` to open the documentation.

Expand Down

0 comments on commit 3dd808e

Please sign in to comment.