Skip to content

Update venv and clean make targets#856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ezio-melotti merged 2 commits into from
May 7, 2022
Merged

Update venv and clean make targets #856

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
194fbd7
Update the `venv` command in the Makefile.
ezio-melotti May 6, 2022
c931962
Add the `clean-env` and updated the `clean` command.
ezio-melotti May 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions Makefile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,23 +3,26 @@

# You can set these variables from the command line.
PYTHON = python3
VENVDIR = ./venv
BUILDDIR = _build
SPHINXOPTS =
SPHINXBUILD = ./venv/bin/sphinx-build
SPHINXBUILD = $(VENVDIR)/bin/sphinx-build
PAPER =
BUILDDIR = _build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp \
.PHONY: help venv clean html dirhtml singlehtml pickle json htmlhelp qthelp \
devhelp epub latex latexpdf text man changes linkcheck doctest htmlview check

help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " venv to create a venv with necessary tools"
@echo " html to make standalone HTML files"
@echo " htmlview to open the index page built by the html target in your browser"
@echo " clean to remove the venv and build files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
Expand All@@ -37,13 +40,22 @@ help:
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " check to run a check for frequent markup errors"

clean:
clean: clean-venv
-rm -rf $(BUILDDIR)/*

clean-venv:
Copy link
Member

@hugovkhugovkMay 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include clean-venv in the help?

Copy link
MemberAuthor

@ezio-melottiezio-melottiMay 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't included in CPython, and I think that's because:

  1. if you try to recreate the venv, it already tells you to use make clean-venv
  2. if you run make clean it also cleans the venv

Because of these reasons and for consistency with CPython, I decided to leave it out.

Copy link
Member

@hugovkhugovkMay 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, sounds good.

rm -rf $(VENVDIR)

venv:
$(PYTHON) -m venv venv
./venv/bin/python3 -m pip install --upgrade pip
./venv/bin/python3 -m pip install -r requirements.txt
@if [ -d $(VENVDIR) ] ; then \
echo "venv already exists." \
echo "To recreate it, remove it first with \`make clean-venv'." \
else \
$(PYTHON) -m venv $(VENVDIR); \
$(VENVDIR)/bin/python3 -m pip install --upgrade pip; \
$(VENVDIR)/bin/python3 -m pip install -r requirements.txt; \
echo "The venv has been created in the $(VENVDIR) directory" \
fi

html: venv
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
Expand Down