openstack
/
freezer
Code Issues Proposed changes

Merge "Adds doc8 check to pep8"

This commit is contained in:
Zuul 2018-08-20 10:48:02 +00:00 committed by Gerrit Code Review
parent 4b951d12d8 401256a6e5
commit 3dbe8d8bb7
16 changed files with 56 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/admin/agent-scheduler-install.rst
View File

@ -41,24 +41,24 @@ Install required packages first:
.. code:: bash
sudo apt-get install python-dev python-pip git openssl gcc make automake
sudo apt-get install python-dev python-pip git openssl gcc make automake
Clone proper branch of Freezer Client with git:
.. code:: bash
git clone -b [branch] https://github.com/openstack/freezer.git
git clone -b [branch] https://github.com/openstack/freezer.git
Install requirements with pip:
.. code:: bash
cd freezer/
cd freezer/
sudo pip install -r requirements.txt
sudo pip install -r requirements.txt
Install freezer from source:
.. code:: bash
sudo python setup.py install
sudo python setup.py install

1
doc/source/admin/index.rst
View File

@ -8,4 +8,3 @@ Table of Contents:
installation
operation

1
doc/source/user/index.rst
View File

@ -8,4 +8,3 @@ User Guide
freezer-agent
freezer-scheduler
freezer-web-ui

38
doc/source/user/installation.rst
View File

@ -38,33 +38,33 @@ Install required packages first:
.. code:: bash
sudo apt-get install python-dev python-pip git openssl gcc make automake
sudo apt-get install python-dev python-pip git openssl gcc make automake
For python3:
.. code:: bash
sudo apt-get install python3-dev git openssl openssl-devel gcc make automake
sudo apt-get install python3-dev git openssl openssl-devel gcc make automake
Clone proper branch of Freezer Client with git:
.. code:: bash
git clone -b [branch] https://github.com/openstack/freezer.git
git clone -b [branch] https://github.com/openstack/freezer.git
Install requirements with pip:
.. code:: bash
cd freezer/
cd freezer/
sudo pip install -r requirements.txt
sudo pip install -r requirements.txt
Install freezer from source:
.. code:: bash
sudo python setup.py install
sudo python setup.py install
Create ENV file:
@ -115,35 +115,35 @@ Install required packages first:
.. code:: bash
sudo yum install python-devel python-pip git openssl \
openssl-devel gcc make automake
sudo yum install python-devel python-pip git openssl \
openssl-devel gcc make automake
For python3:
.. code:: bash
sudo apt-get install python3-devel git openssl \
openssl-devel gcc make automake
sudo apt-get install python3-devel git openssl \
openssl-devel gcc make automake
Clone proper branch of Freezer Client with git:
.. code:: bash
git clone -b [branch] https://github.com/openstack/freezer.git
git clone -b [branch] https://github.com/openstack/freezer.git
Install requirements with pip:
.. code:: bash
cd freezer/
cd freezer/
sudo pip install -r requirements.txt
sudo pip install -r requirements.txt
Install freezer from source:
.. code:: bash
sudo python setup.py install
sudo python setup.py install
Create ENV file:
@ -214,8 +214,8 @@ After you have installed required packages install pip:
.. code:: bash
easy_install -U pip
pip install freezer
easy_install -U pip
pip install freezer
Freezer scheduler on windows run as a windows service and it needs to be installed as a user service:
@ -223,11 +223,11 @@ Freezer scheduler on windows run as a windows service and it needs to be install
.. code:: bash
whoami
whoami
cd C:\Python27\Lib\site-packages\freezer\scheduler
cd C:\Python27\Lib\site-packages\freezer\scheduler
python win_service.py --username {whoami} --password {pc-password} install
python win_service.py --username {whoami} --password {pc-password} install
Unofficial Installer for Windows
--------------------------------

1
lower-constraints.txt
View File

@ -17,6 +17,7 @@ ddt==1.0.1
debtcollector==1.19.0
decorator==4.2.1
deprecation==2.0
doc8==0.6.0
docutils==0.14
dogpile.cache==0.6.5
dulwich==0.19.0

4
test-requirements.txt
View File

@ -19,3 +19,7 @@ tempest>=17.1.0 # Apache-2.0
# Used in integration tests
python-openstackclient>=3.12.0 # Apache-2.0
# Used in doc8 check
doc8>=0.6.0 # Apache-2.0
Pygments>=2.2.0 # BSD license

8
tox.ini
View File

@ -65,7 +65,9 @@ commands =
[testenv:pep8]
commands = flake8 freezer
commands =
flake8 freezer
doc8 {posargs}
[testenv:pylint]
commands = pylint --rcfile .pylintrc freezer
@ -76,6 +78,10 @@ show-source = True
enable-extensions = H203,H106
exclude = .venv,.tox,dist,doc,test,*egg,releasenotes
[doc8]
ignore = D000,D001
ignore-path = .venv,.git,.tox,.tmp,*freezer/locale*,*lib/python*,freezer.egg*,doc/build,releasenotes/*,doc/source/contributor/api
[testenv:releasenotes]
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html