Skip to content

Commit

Permalink
Fix make targets and .gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
has2k1 committed Aug 8, 2023
1 parent 7eec66a commit 7b777fe
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 20 deletions.
5 changes: 2 additions & 3 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,12 @@ jobs:
- name: Install Package
run: |
python -m pip install ".[doc]"
python -m pip install -r requirements/doc.txt
- name: Build docs
run: |
make render
make doc
- name: Deploy to Github Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: _site
folder: qdoc/_site
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,12 @@ benchmarks

# version file generated by setuptools-scm
plotnine/_version.py

# Documentation
qdoc/plotnine-examples
qdoc/reference/
qdoc/_site/
qdoc/.quarto/
qdoc/gallery/thumbnails
qdoc/objects.json
qdoc/.luarc.json
9 changes: 2 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,10 @@ coverage:
coverage html
$(BROWSER) htmlcov/index.html

# doc:
# $(MAKE) -C doc clean
# $(MAKE) -C doc html
# $(BROWSER) doc/_build/html/index.html

doc:
$(MAKE) -C qdoc doc
$(MAKE) -C qdoc render

qdoc-preview:
doc-preview:
$(MAKE) -C qdoc preview

release: clean
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ doc = [
"click",
"numpydoc>=0.9.1",
"sphinx>=6.1.0",
"quartodoc",
"pyyaml",
# Use importlib.resources when min supported python >= 3.9.0
"importlib_resources",
Expand Down
8 changes: 1 addition & 7 deletions qdoc/.gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1 @@
plotnine-examples
reference/
_site/
.quarto/
gallery/thumbnails
objects.json
.luarc.json
/.quarto/
4 changes: 3 additions & 1 deletion qdoc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@ setup:
rm -rf plotnine-examples
git clone https://github.com/has2k1/plotnine-examples.git

doc:
render:
DOC_GENERATION=1 python -m quartodoc build
quarto render

doc: render

preview:
quarto preview
2 changes: 0 additions & 2 deletions requirements/doc.txt

This file was deleted.

0 comments on commit 7b777fe

Please sign in to comment.