Skip to content

Commit

Permalink
#2 moved commands from poetry scripts to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ephes committed Nov 3, 2022
1 parent d259bc3 commit bf35878
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 101 deletions.
37 changes: 37 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,40 @@ Running the Example App

# activate virtualenv where wagtail_srcset is installed
python manage.py runserver --settings example.settings 0.0:8000

Run Linter
----------

::

# activate virtualenv where wagtail_srcset is installed
flake8 wagtail_srcset tests

Coverage
--------

::

# activate virtualenv where wagtail_srcset is installed
pytest --cov=wagtail_srcset --cov-report=html

Start a Notebook Server
-----------------------

::

# activate virtualenv where wagtail_srcset is installed
DJANGO_ALLOW_ASYNC_UNSAFE=true python manage.py shell_plus --notebook


Build Documentation
-------------------

::

# activate virtualenv where wagtail_srcset is installed
rm docs/modules.rst docs/wagtail_srcset.rst
sphinx-apidoc -o docs/ wagtail_srcset
make -C docs clean
make -C docs html
open docs/_build/html/index.html
101 changes: 0 additions & 101 deletions commands.py

This file was deleted.

0 comments on commit bf35878

Please sign in to comment.