Merge pull request #61 from ealcobaca/doc-test

Doc test

.readthedocs.yml

@@ -10,7 +10,8 @@ sphinx:
   configuration: docs/source/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
-formats: all
+formats:
+  - htmlzip
 
 # Optionally set the version of Python and requirements required to build your
 # docs

Makefile

@@ -1,5 +1,7 @@
+PACKAGE := pymfe
+
 all: clean install-dev code-check test-cov
-.PHONY: all clean test test-cov code-check pypi install install-dev
+.PHONY: all clean test test-cov code-check pypi install install-dev html help h t c cl
 
 clean: ## Clean all undesired files such as .so, .pyc, build files and etc.
 	find . -name "*.so" -o -name "*.pyc" -o -name "*.md5" -o -name "*.pyd" -o -name "*~" | xargs rm -f
@@ -11,19 +13,26 @@ clean: ## Clean all undesired files such as .so, .pyc, build files and etc.
 	rm -rf docs/source/auto_examples
 	cd docs ; make clean_all
 
+cl: clean ## Shortcut to clean
+
 test: ## Execute the code test using pytest.
 	pytest tests/
 
 test-cov: ## Execute the code test using pytest and measuring the coverage.
 	rm -rf coverage .coverage
-	pytest --cov=pymfe/ tests/
+	pytest --cov=$(PACKAGE)/ tests/
+
+t: test-cov ## Shortcut to test-cov
 
 code-check: ## Execute the code check with flake8, pylint, mypy.
-	flake8 pymfe
-	pylint pymfe -d 'C0103, R0913, R0902, R0914, C0302, R0904, R0801, E1101'
-	mypy pymfe --ignore-missing-imports
+	flake8 $(PACKAGE)
+	pylint $(PACKAGE) -d 'C0103, R0913, R0902, R0914, C0302, R0904, R0801, E1101'
+	mypy $(PACKAGE) --ignore-missing-imports
 
-pypi: clean ## Send pymfe to pypi.
+c: code-check # Shortcut to code-check
+
+pypi: clean ## Send the package to pypi.
+	pip install -U twine wheel
 	python3 setup.py sdist bdist_wheel
 	twine upload dist/*
 
@@ -33,11 +42,13 @@ install-dev: ## Install pymfe for developers using pip.
 	pip install -U -r requirements-dev.txt
 	pip install -U -r requirements-docs.txt
 
-install: ## Install pymfe using pip.
+install: ## Install the package using pip.
 	pip install .
 
 html: ## Create the online documentation.
 	cd docs; make html
 
 help: ## List target command description.
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+h: help ## Shortcut to help

docs/source/api.rst

@@ -126,23 +126,6 @@ This is the full API documentation of the `pymfe` toolbox.
 
 .. _clustering_ref:
 
-:mod:`pymfe.clustering`: Clustering Meta-features
-=================================================
-
-.. automodule:: pymfe.clustering
-   :no-members:
-   :no-inherited-members:
-
-.. currentmodule:: pymfe
-
-.. autosummary::
-   :toctree: generated/
-
-   clustering.MFEClustering
-
-
-.. _concept_ref:
-
 :mod:`pymfe.concept`: Concept Meta-features
 ===================================================
 

docs/source/conf.py

@@ -27,7 +27,7 @@
 
 # The full version, including alpha/beta/rc tags.
 from pymfe import __version__
-release = __version__
+version = release = __version__
 
 
 # -- General configuration ---------------------------------------------------