diff --git a/build-docs.sh b/build-docs.sh index 523d06c1e807d586d59588013cc9dc58ea086408..75de76c97db870f8fd7d46ad1e1fd679ad6a7d64 100755 --- a/build-docs.sh +++ b/build-docs.sh @@ -1,4 +1,5 @@ python docs/dump-openapi-spec.py 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 diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index bc0ae93593d6c7a6699160d3563e39d917802d5b..2ff56ee371eca840db1f62cd0a4c6fff69073d85 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -1,9 +1,9 @@ -Quick Start +Quick start ================== *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:* @@ -31,7 +31,7 @@ Install the Module # for a full dev environment pip install -r requirements.txt -Running the App +Running the app ------------------- * Create a settings file, see `config.json.example` for an example. diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini index 4741a77d536e2e35dadcde11a61564e7b553dfb2..0fbe065755c821863e40c799c936f65383c395f8 100644 --- a/docs/vale/.vale.ini +++ b/docs/vale/.vale.ini @@ -9,5 +9,5 @@ Packages = proselint, Microsoft [*] BasedOnStyles = Vale, proselint, Microsoft -; Ignore the table of contents directive -BlockIgnores = (?s) *(\x60\x60\x60{toctree}.*?\x60\x60\x60) +[formats] +py = rst diff --git a/docs/vale/styles/Vocab/Sphinx/accept.txt b/docs/vale/styles/Vocab/Sphinx/accept.txt index 1c26bb264fd26def95b47f76db7bd31eb9fe37a2..0a57a0fe336bf64acee73b3caaf5b58ba4e3fa61 100644 --- a/docs/vale/styles/Vocab/Sphinx/accept.txt +++ b/docs/vale/styles/Vocab/Sphinx/accept.txt @@ -1 +1 @@ -toctree +param diff --git a/docs/vale/styles/Vocab/geant-jargon/accept.txt b/docs/vale/styles/Vocab/geant-jargon/accept.txt index dcfefe8ab4117be2cf58c4468254eeb414afeb09..33037056a51f1d9d7900b9e089a70fac3633fab7 100644 --- a/docs/vale/styles/Vocab/geant-jargon/accept.txt +++ b/docs/vale/styles/Vocab/geant-jargon/accept.txt @@ -1,3 +1,2 @@ -lso -LSO +[LSO|lso] [Ss]ubpackages diff --git a/lso/__init__.py b/lso/__init__.py index c18f1f392e2db8f4f19454a1e57fe298bdfad308..757477d2543bb01ef487c8160a03a9a1a8934c8d 100644 --- a/lso/__init__.py +++ b/lso/__init__.py @@ -15,7 +15,7 @@ from lso.routes import default, device def create_app(): """ 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 """ diff --git a/tox.ini b/tox.ini index ab6a6bcce62c94dd93a88ec6683c5e567e29e968..c0e8872a55c37fc99090ce5b14766a4475fe1fe1 100644 --- a/tox.ini +++ b/tox.ini @@ -16,4 +16,7 @@ commands = coverage report --fail-under 80 flake8 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