Skip to content

Commit

Permalink
Switch to Pyink
Browse files Browse the repository at this point in the history
  • Loading branch information
Nitin Prasad committed Oct 26, 2023
1 parent 5a25d67 commit 0b3a4bc
Show file tree
Hide file tree
Showing 88 changed files with 6,270 additions and 4,294 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ jobs:
- name: Check formatting
run: |
python -m pip install yapf
yapf -drp .
python -m pip install pyink
pyink --check .
5 changes: 0 additions & 5 deletions .style.yapf

This file was deleted.

2 changes: 0 additions & 2 deletions .yapfignore

This file was deleted.

8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,16 @@ mobly $ tox
```

### Code style
Before pushing your changes, you need to lint the code style via `yapf`
Before pushing your changes, you need to lint the code style via `pyink`

To install `yapf`:
To install `pyink`:

```sh
$ pip3 install yapf
$ pip3 install pyink
```

To lint the code:

```sh
mobly $ yapf -irp .
mobly $ pyink .
```
47 changes: 30 additions & 17 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.todo',
'sphinx.ext.viewcode'
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -55,18 +57,18 @@
master_doc = 'index'

# General information about the project.
project = u'Mobly'
copyright = u'Copyright 2016 Google Inc.'
author = u'Ang Li'
project = 'Mobly'
copyright = 'Copyright 2016 Google Inc.'
author = 'Ang Li'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u''
version = ''
# The full version, including alpha/beta/rc tags.
release = u''
release = ''

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -79,8 +81,12 @@
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = [
'_build', 'Thumbs.db', '.DS_Store', 'tutorial.md',
'instrumentation_tutorial.md', 'android_device_service.md'
'_build',
'Thumbs.db',
'.DS_Store',
'tutorial.md',
'instrumentation_tutorial.md',
'android_device_service.md',
]

# The name of the Pygments (syntax highlighting) style to use.
Expand Down Expand Up @@ -118,15 +124,12 @@
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
Expand All @@ -136,24 +139,34 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Mobly.tex', u'Mobly Documentation', u'Ang Li', 'manual'),
(master_doc, 'Mobly.tex', 'Mobly Documentation', 'Ang Li', 'manual'),
]

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, 'mobly', u'Mobly Documentation', [author], 1)]
man_pages = [(master_doc, 'mobly', 'Mobly Documentation', [author], 1)]

# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Mobly', u'Mobly Documentation', author, 'Mobly',
'Mobly is a Python-based test framework that specializes in supporting tests that require multiple devices, complex environments, or custom hardware setups.',
'Miscellaneous'),
(
master_doc,
'Mobly',
'Mobly Documentation',
author,
'Mobly',
(
'Mobly is a Python-based test framework that specializes in'
' supporting tests that require multiple devices, complex'
' environments, or custom hardware setups.'
),
'Miscellaneous',
),
]

# -- Options for Epub output ----------------------------------------------
Expand Down
Loading

0 comments on commit 0b3a4bc

Please sign in to comment.