📚 🔥 updating documentation and remove drone

brazil-data-cube · Nov 22, 2023 · b1f5104 · b1f5104
1 parent 04576fa
commit b1f5104
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 94 deletions.
diff --git a/.drone.yml b/.drone.yml
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -18,13 +18,18 @@
 
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+
 sphinx:
     configuration: docs/sphinx/conf.py
 
 formats: []
 
 python:
-    version: 3.7
 
     install:
         - method: pip

diff --git a/CLI.rst b/CLI.rst
@@ -1,6 +1,6 @@
 ..
     This file is part of Python Client Library for WLTS.
-    Copyright (C) 2022 INPE.
+    Copyright (C) 2023 INPE.
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -46,25 +46,25 @@ Retrieve the trajectory given a longitude and latitude::
              --longitude -54.0  \
              --start-date 2001 \
              --end-date 2011 \
-             --collections mapbiomas-v6
+             --collections mapbiomas-v8
 
 
 The above command will return a document as:
 
 .. code-block:: shell
 
        trajectory: [
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2001'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2002'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2003'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2004'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2005'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2006'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2007'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2008'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2009'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2010'},
-        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v6', 'date': '2011'}
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2001'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2002'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2003'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2004'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2005'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2006'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2007'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2008'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2009'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2010'},
+        {'class': 'Formação Florestal', 'collection': 'mapbiomas-v8', 'date': '2011'}
        ]
 
 .. note::

diff --git a/INSTALL.rst b/INSTALL.rst
@@ -1,6 +1,6 @@
 ..
     This file is part of Python Client Library for WLTS.
-    Copyright (C) 2022 INPE.
+    Copyright (C) 2023 INPE.
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -22,20 +22,8 @@ Installation
 ``wlts.py`` depends essentially on `Requests <https://requests.readthedocs.io/en/master/>`_. Please, read the instructions below in order to install ``wlts.py``.
 
 
-Production installation
------------------------
-
-**Under Development!**
-
-.. Install from `PyPI <https://pypi.org/>`_:
-..
-.. .. code-block:: shell
-..
-..     $ pip3 install wlts.py
-
-
-Development Installation - GitHub
----------------------------------
+Development Installation
+------------------------
 
 Clone the Software Repository::
 
@@ -52,6 +40,26 @@ Install in development mode::
     pip3 install -e .[all]
 
 
+.. note::
+
+    If you want to create a new *Python Virtual Environment*, please, follow this instruction:
+
+    *1.* Create a new virtual environment linked to Python 3.11::
+
+        python3.11 -m venv venv
+
+
+    **2.** Activate the new environment::
+
+        source venv/bin/activate
+
+
+    **3.** Update pip and setuptools::
+
+        pip3 install --upgrade pip
+
+        pip3 install --upgrade setuptools
+
 Run the Tests
 +++++++++++++
 
@@ -64,7 +72,7 @@ Build the Documentation
 
 You can generate the documentation based on Sphinx with the following command::
 
-    python setup.py build_sphinx
+    sphinx-build docs/sphinx docs/sphinx/_build/html
 
 
 The above command will generate the documentation in HTML and it will place it under::

diff --git a/README.rst b/README.rst
@@ -1,6 +1,6 @@
 ..
     This file is part of Python Client Library for WLTS.
-    Copyright (C) 2022 INPE.
+    Copyright (C) 2023 INPE.
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -21,17 +21,9 @@ Python Client Library for Web Land Trajectory Service
 =====================================================
 
 .. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
-        :target: https://github.com/brazil-data-cube/bdc-catalog/blob/master/LICENSE
+        :target: https://github.com/brazil-data-cube/wlts.py/blob/master/LICENSE
         :alt: Software License
 
-.. image:: https://drone.dpi.inpe.br/api/badges/brazil-data-cube/wlts.py/status.svg
-        :target: https://drone.dpi.inpe.br/brazil-data-cube/wlts.py
-        :alt: Build Status
-
-.. image:: https://codecov.io/gh/brazil-data-cube/wlts.py/branch/master/graph/badge.svg?token=1R1NNI56JO
-        :target: https://codecov.io/gh/brazil-data-cube/wlts.py
-        :alt: Code Coverage Test
-
 .. image:: https://readthedocs.org/projects/wlts/badge/?version=latest
         :target: https://wlts.readthedocs.io/en/latest/?badge=latest
         :alt: Documentation Status
@@ -95,7 +87,7 @@ License
 =======
 
 .. admonition::
-    Copyright (C) 2022 INPE.
+    Copyright (C) 2023 INPE.
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by

diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst
@@ -27,9 +27,9 @@ Documentation
    :caption: Contents:
 
    installation
-   api
    cli
    examples
+   api
    repository
    history
    license