Skip to content
Snippets Groups Projects
Verified Commit cc3117ac authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

Resolve Vale errors, lint pydoc too

parent 4a62bcf9
No related branches found
No related tags found
1 merge request!10Add docstrings to generated documentation
python docs/dump-openapi-spec.py python docs/dump-openapi-spec.py
sphinx-apidoc lso lso/app.py -o docs/source -d 2 -f sphinx-apidoc lso lso/app.py -o docs/source -d 2 -f
vale --config=docs/vale/.vale.ini docs/source/*.rst lso/*.py
sphinx-build -b html docs/source docs/build sphinx-build -b html docs/source docs/build
Quick Start Quick start
================== ==================
*This is a quick setup guide for running standalone on your local machine* *This is a quick setup guide for running standalone on your local machine*
Install the Module Install the module
-------------------- --------------------
*One of these should be what you're looking for:* *One of these should be what you're looking for:*
...@@ -31,7 +31,7 @@ Install the Module ...@@ -31,7 +31,7 @@ Install the Module
# for a full dev environment # for a full dev environment
pip install -r requirements.txt pip install -r requirements.txt
Running the App Running the app
------------------- -------------------
* Create a settings file, see `config.json.example` for an example. * Create a settings file, see `config.json.example` for an example.
......
...@@ -9,5 +9,5 @@ Packages = proselint, Microsoft ...@@ -9,5 +9,5 @@ Packages = proselint, Microsoft
[*] [*]
BasedOnStyles = Vale, proselint, Microsoft BasedOnStyles = Vale, proselint, Microsoft
; Ignore the table of contents directive [formats]
BlockIgnores = (?s) *(\x60\x60\x60{toctree}.*?\x60\x60\x60) py = rst
toctree param
lso [LSO|lso]
LSO
[Ss]ubpackages [Ss]ubpackages
...@@ -15,7 +15,7 @@ from lso.routes import default, device ...@@ -15,7 +15,7 @@ from lso.routes import default, device
def create_app(): def create_app():
""" """
overrides default settings with those found overrides default settings with those found
in the file read from env var SETTINGS_FILENAME in the file read from environment variable `SETTINGS_FILENAME`
:return: a new flask app instance :return: a new flask app instance
""" """
......
...@@ -16,4 +16,7 @@ commands = ...@@ -16,4 +16,7 @@ commands =
coverage report --fail-under 80 coverage report --fail-under 80
flake8 flake8
python docs/dump-openapi-spec.py python docs/dump-openapi-spec.py
sphinx-apidoc lso lso/app.py -o docs/source -d 2 -f
vale --config=docs/vale/.vale.ini sync
vale --config=docs/vale/.vale.ini docs/source/*.rst lso/*.py
sphinx-build -b html docs/source docs/build sphinx-build -b html docs/source docs/build
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment