Skip to content

Commit

Permalink
Fix install instructions in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
einarf committed Oct 13, 2023
1 parent 7a43a83 commit 38c46bd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 28 deletions.
26 changes: 7 additions & 19 deletions docs/guide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ moderngl-window is available on PyPI::

pip install moderngl-window

Optional dependencies
Optional Dependencies
---------------------

We try to have as few requirements as possible and instead offer
Expand Down Expand Up @@ -58,8 +58,9 @@ Installing from source
# Install moderngl-window in editable mode
pip install -e .
# Install optional dev dependencies covering all window and loader types
pip install -r requirements.txt
# Install optional dev dependencies
pip install -e .[dev]
pip install -e .[docs]
Installing the package in editable mode will make you able
to run tests and examples. We highly recommend using
Expand All @@ -70,26 +71,13 @@ Running examples

Assuming you installed from source you should be able to run the examples
in the `examples` directory directly after installing the dev requirements
in the root of the project::

pip install -r requirements.txt
in the root of the project.

Running tests
-------------

Install test requirements::

pip install -r tests/requirements.txt
Assuming dev requirements are installed.

Run tests with ``tox``::

# Run for specific environment
tox -e py35
tox -e py36
tox -e py37

# pep8 run
tox -e pep8

# Run all environments
tox
pytest
9 changes: 0 additions & 9 deletions docs/guide/window_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,6 @@ The ``swap_buffers`` method is important as it also pulls new input
events for the next frame.











Old Guide
=========

Expand Down

0 comments on commit 38c46bd

Please sign in to comment.