updated documentation instructions

mxaviersmp · mxaviersmp · commit c64da316e3bc · 2021-03-11T23:55:24.000-03:00
diff --git a/.documentation.md b/.documentation.md
@@ -102,4 +102,4 @@ following command:
 To update the documentation just run the following command and move
  the generated files to the folder `references/`.
 
-`sphinx-apidoc -o docs pymove`
+`sphinx-apidoc -f -o docs/references pymove pymove/tests/`
diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@ help:
 	@echo " - clean  : clean temporary folders and files"
 	@echo " - test   : runs all unit tests"
 	@echo " - lint   : checks code style"
-	@echo " - doc    : creates documentation in html"
+	@echo " - docs   : creates documentation in html"
 
 dev:
 	pip install -r requirements-dev.txt
@@ -24,5 +24,6 @@ test: clean
 lint: clean
 	flake8
 
-doc: clean
+docs: clean
+	sphinx-apidoc -f -o docs/references pymove pymove/tests/
 	make -C docs html
diff --git a/docs/references/modules.rst b/docs/references/modules.rst
@@ -0,0 +1,7 @@
+pymove
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   pymove
diff --git a/docs/references/pymove.core.rst b/docs/references/pymove.core.rst
@@ -44,10 +44,10 @@ pymove.core.pandas module
    :undoc-members:
    :show-inheritance:
 
-pymove.core.pandas_discrete module
-----------------------------------
+pymove.core.pandas\_discrete module
+-----------------------------------
 
-.. automodule:: pymove.core.pandas
+.. automodule:: pymove.core.pandas_discrete
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/references/pymove.models.pattern_mining.rst b/docs/references/pymove.models.pattern_mining.rst
@@ -12,6 +12,30 @@ pymove.models.pattern\_mining.clustering module
    :undoc-members:
    :show-inheritance:
 
+pymove.models.pattern\_mining.freq\_seq\_patterns module
+--------------------------------------------------------
+
+.. automodule:: pymove.models.pattern_mining.freq_seq_patterns
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pymove.models.pattern\_mining.moving\_together\_patterns module
+---------------------------------------------------------------
+
+.. automodule:: pymove.models.pattern_mining.moving_together_patterns
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pymove.models.pattern\_mining.periodic\_patterns module
+-------------------------------------------------------
+
+.. automodule:: pymove.models.pattern_mining.periodic_patterns
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 
diff --git a/docs/references/pymove.models.rst b/docs/references/pymove.models.rst
@@ -12,6 +12,22 @@ Subpackages
 Submodules
 ----------
 
+pymove.models.anomaly\_detection module
+---------------------------------------
+
+.. automodule:: pymove.models.anomaly_detection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pymove.models.classification module
+-----------------------------------
+
+.. automodule:: pymove.models.classification
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 
diff --git a/docs/references/pymove.preprocessing.rst b/docs/references/pymove.preprocessing.rst
@@ -20,14 +20,6 @@ pymove.preprocessing.filters module
    :undoc-members:
    :show-inheritance:
 
-pymove.preprocessing.map\_matching module
------------------------------------------
-
-.. automodule:: pymove.preprocessing.map_matching
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 pymove.preprocessing.segmentation module
 ----------------------------------------
 
@@ -44,7 +36,6 @@ pymove.preprocessing.stay\_point\_detection module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 
diff --git a/docs/references/pymove.rst b/docs/references/pymove.rst
@@ -10,12 +10,11 @@ Subpackages
    pymove.core
    pymove.models
    pymove.preprocessing
-   pymove.query
    pymove.semantic
+   pymove.uncertainty
    pymove.utils
    pymove.visualization
 
-
 Module contents
 ---------------
 
diff --git a/docs/references/pymove.semantic.rst b/docs/references/pymove.semantic.rst
@@ -12,7 +12,6 @@ pymove.semantic.semantic module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 
diff --git a/docs/references/pymove.uncertainty.rst b/docs/references/pymove.uncertainty.rst
@@ -0,0 +1,29 @@
+pymove.uncertainty package
+==========================
+
+Submodules
+----------
+
+pymove.uncertainty.privacy module
+---------------------------------
+
+.. automodule:: pymove.uncertainty.privacy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pymove.uncertainty.reducing module
+----------------------------------
+
+.. automodule:: pymove.uncertainty.reducing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: pymove.uncertainty
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/references/pymove.utils.rst b/docs/references/pymove.utils.rst
@@ -20,8 +20,8 @@ pymove.utils.conversions module
    :undoc-members:
    :show-inheritance:
 
-pymove.utils.data_augmentation module
--------------------------------------
+pymove.utils.data\_augmentation module
+--------------------------------------
 
 .. automodule:: pymove.utils.data_augmentation
    :members:
@@ -100,7 +100,6 @@ pymove.utils.visual module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 
diff --git a/docs/references/pymove.visualization.rst b/docs/references/pymove.visualization.rst
@@ -20,7 +20,6 @@ pymove.visualization.matplotlib module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +pymove
 +======
++
 +.. toctree::
 +   :maxdepth: 4
++
 +   pymove