diff --git a/Makefile b/Makefile index 1bcd80bb..e650b479 100644 --- a/Makefile +++ b/Makefile @@ -1,20 +1,26 @@ -install: - @python setup.py build install +# Minimal makefile for Sphinx documentation +# -install-dependencies: - @python -m pip install -e .[all] +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = jMetalPy +SOURCEDIR = docs/source +BUILDDIR = build -clean: - @rm -rf build dist .eggs *.egg-info - @find . -type d -name '.mypy_cache' -exec rm -rf {} + - @find . -type d -name '__pycache__' -exec rm -rf {} + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -black: clean - @isort --profile black jmetal/ examples/ - @black jmetal/ examples/ +.PHONY: help Makefile -lint: - @mypy jmetal/ examples/ --show-error-codes +# "make github" option to build gh-pages +github: + @make html + @cp -a $(BUILDDIR)/html/. docs + @rm -r $(BUILDDIR) -tests: - @python -m unittest discover -q \ No newline at end of file +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/source/conf.py b/docs/source/conf.py index 2ce056bb..500c8c63 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -11,7 +11,7 @@ copyright = '2019, Antonio Benítez-Hidalgo' author = 'Antonio Benítez-Hidalgo' version = '' -release = '1.5.3' +release = '1.7.0' # -- General configuration --------------------------------------------------- @@ -33,7 +33,7 @@ templates_path = ['_templates'] source_suffix = '.rst' master_doc = 'index' -language = None +language = "en" pygments_style = 'sphinx' # -- Options for HTML output -------------------------------------------------