diff --git a/docs/Makefile b/docs/Makefile index eb67caf8..d4bb2cbb 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,10 +1,10 @@ # Minimal makefile for Sphinx documentation # -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = inequality +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = _build @@ -17,18 +17,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @rsync -r --exclude '.ipynb_checkpoints/' ../notebooks/ ./notebooks/ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -github: - @make html - -sync: - @rsync -avh _build/html/ ../docs/ --delete - @make clean - touch .nojekyll - -clean: - rm -rf $(BUILDDIR)/* - rm -rf auto_examples/ - rm -rf generated/ diff --git a/docs/api.rst b/docs/api.rst index d6fe0fbb..f863a0c4 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -27,3 +27,12 @@ Gini Inequality Measures inequality.gini.Gini inequality.gini.Gini_Spatial +Pengram +------- + +.. autosummary:: + :toctree: generated/ + + inequality.pen.pen + inequality.pen.pengram +