Skip to content

Commit

Permalink
add some usage info to make doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Nothing4You committed Apr 7, 2022
1 parent 04d06fd commit e098883
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,15 @@ start_mysql:
stop_mysql:
docker-compose -f docker-compose.yml stop mysql

# TODO: this depends on aiomysql being installed, e.g. in a venv.
# TODO: maybe this can be solved better.
doc:
@echo "----------------------------------------------------------------"
@echo "Doc builds require installing the aiomysql package in the"
@echo "environment. Make sure you've installed your current dev version"
@echo "into your environment, e.g. using venv, then run this command in"
@echo "the virtual environment."
@echo "----------------------------------------------------------------"
git fetch --tags --all
make -C docs html
@echo "open file://`pwd`/docs/_build/html/index.html"
Expand Down

0 comments on commit e098883

Please sign in to comment.