Merge branch 'fix/remove-pip' into 'master'

Fix/remove pip

See merge request ska-telescope/templates/ska-python-skeleton!4

.gitlab-ci.yml

@@ -10,8 +10,8 @@ cache:
 # before_script is used to define the command that should be run before all jobs, including deploy jobs, but after the restoration of artifacts.
 # This can be an array or a multi-line string.
 before_script:
-  - pip install pipenv
-  - pipenv install
+  - python3 -m pip install -r docker-requirements.txt
+  
 
 stages:
   - test
@@ -29,7 +29,8 @@ test:
 #  tags:
 #   - docker-executor
   script:
-   - pipenv run python setup.py test
+  #  - pipenv run python setup.py test
+   - python3 setup.py test
    - mv coverage.xml ./build/reports/code-coverage.xml
   artifacts:
     paths:
@@ -39,11 +40,14 @@ test:
 list_dependencies:
   stage: test
   script:
-    - pipenv graph >> pipenv_deps.txt
+    # - pipenv graph >> pipenv_deps.txt
+    - pipdeptree --json >> pip_deps.json
+    - pipdeptree >> pip_deps.txt
     - dpkg -l >> system_deps.txt
     - awk 'FNR>5 {print $2 ", " $3}' system_deps.txt >> system_deps.csv
     - mkdir .public
-    - cp pipenv_deps.txt .public/
+    - cp pip_deps.txt .public/
+    - cp pip_deps.json .public/
     - cp system_deps.txt .public/
     - cp system_deps.csv .public/
     - mv .public public

README.md

@@ -14,9 +14,9 @@ Install
 -------
 
 **Always** use a virtual environment. [Pipenv](https://pipenv.readthedocs.io/en/latest/) is now Python's officially
-recommended method and the one used by default in this repo.
+recommended method, but we are not using it for installing requirements when building on the CI Pipeline. You are encouraged to use your preferred environment isolation (i.e. `pip`, `conda` or `pipenv` while developing locally.
 
-Follow these steps at the project root:
+For working with `Pipenv`, follow these steps at the project root:
 
 First, ensure that `~/.local/bin` is in your `PATH` with:
 ```bash

docker-requirements.txt

@@ -12,3 +12,5 @@ sphinx_rtd_theme
 sphinx-autobuild
 sphinx-rtd-theme
 sphinxcontrib-websupport
+pipdeptree
+pylint_junit
\ No newline at end of file

docs/src/index.rst

@@ -22,7 +22,7 @@
    :maxdepth: 2
    :caption: Readme
 
-   README
+   ../../README
 
 .. COMMUNITY SECTION ==================================================
 
@@ -30,14 +30,14 @@
 
 .. toctree::
   :maxdepth: 2
-  :caption: Package-name
+  :caption: Package name
   :hidden:
 
   package/guide
 
 
-Project-name documentation
-==========================
+Project-name documentation HEADING
+==================================
 
 These are all the packages, functions and scripts that form part of the project.