From 38234a1d3cccf42374716f00c88858b73cd6c848 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Verg=C3=A9?= Date: Thu, 21 Jan 2016 21:48:57 +0100 Subject: [PATCH] Doc: Generate documentation with Sphinx HTML documentation should be built with sphinx. This enables easy integration with Read The Docs [1]. It can also be generated manually by running: make -C docs html A man page can be generated by running: make -C docs man [1]: http://yamllint.readthedocs.org/ --- .gitignore | 1 + docs/Makefile | 177 +++++++++++++++++++++++++++++++++++++++++ docs/conf.py | 43 ++++++++++ docs/configuration.rst | 5 ++ docs/development.rst | 5 ++ docs/index.rst | 18 +++++ docs/quickstart.rst | 77 ++++++++++++++++++ docs/rules.rst | 90 +++++++++++++++++++++ docs/text_editors.rst | 40 ++++++++++ yamllint/__init__.py | 4 +- 10 files changed, 458 insertions(+), 2 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/configuration.rst create mode 100644 docs/development.rst create mode 100644 docs/index.rst create mode 100644 docs/quickstart.rst create mode 100644 docs/rules.rst create mode 100644 docs/text_editors.rst diff --git a/.gitignore b/.gitignore index 58af8a2..96ce86b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ __pycache__ *.py[cod] +/docs/_build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..8223a7d --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/yamllint.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/yamllint.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/yamllint" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/yamllint" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..0c29484 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +# yamllint documentation build configuration file, created by +# sphinx-quickstart on Thu Jan 21 21:18:52 2016. + +import sys +import os + +sys.path.insert(0, os.path.abspath('..')) # noqa + +from yamllint import __copyright__, APP_NAME, APP_VERSION + +# -- General configuration ------------------------------------------------ + +extensions = [ + 'sphinx.ext.autodoc', +] + +source_suffix = '.rst' + +master_doc = 'index' + +project = APP_NAME +copyright = __copyright__ + +version = APP_VERSION +release = APP_VERSION + +pygments_style = 'sphinx' + +# -- Options for HTML output ---------------------------------------------- + +html_theme = 'default' + +htmlhelp_basename = 'yamllintdoc' + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'yamllint', u'yamllint Documentation', + [u'Adrien Vergé'], 1) +] diff --git a/docs/configuration.rst b/docs/configuration.rst new file mode 100644 index 0000000..1702360 --- /dev/null +++ b/docs/configuration.rst @@ -0,0 +1,5 @@ +Configuration +============= + +yamllint uses a set of *rules* to check sources files for problems. Each rule is +independent from the others, and can be enabled, disabled or tweaked. diff --git a/docs/development.rst b/docs/development.rst new file mode 100644 index 0000000..c6633e7 --- /dev/null +++ b/docs/development.rst @@ -0,0 +1,5 @@ +Development +=========== + +.. automodule:: yamllint + :members: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..e0887af --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,18 @@ +yamllint documentation +====================== + +.. toctree:: + :maxdepth: 2 + + quickstart + configuration + rules + development + text_editors + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/quickstart.rst b/docs/quickstart.rst new file mode 100644 index 0000000..9c6de28 --- /dev/null +++ b/docs/quickstart.rst @@ -0,0 +1,77 @@ +Quickstart +========== + +Installing yamllint +------------------- + +First, install yamllint. The easiest way is to use pip, the Python package +manager: + +:: + + sudo pip install yamllint + +If you prefer installing from source, you can run, from the source directory: + +:: + + python setup.py sdist + sudo pip install dist/yamllint-*.tar.gz + +Running yamllint +---------------- + +Basic usage: + +:: + + yamllint file.yml other-file.yaml + +You can also lint all YAML files in a whole directory: + +:: + + yamllint . + +The output will look like (colors are not displayed here [#colored-output]_): + +:: + + file.yml + 6:2 warning missing starting space in comment (comments) + 57:1 error trailing spaces (trailing-spaces) + 60:3 error wrong indentation: expected 4 but found 2 (indentation) + + other-file.yml + 1:1 warning missing document start "---" (document-start) + 9:81 error line too long (84 > 80 characters) (line-length) + 31:1 error too many blank lines (4 > 2) (empty-lines) + 37:12 error too many spaces inside braces (braces) + +Add the ``-f parsable`` arguments if you need an output format parsable by a +machine (for instance for :doc:`syntax highlighting in text editors +`). The output will then look like: + +:: + + file.yml:6:2: [warning] missing starting space in comment (comments) + file.yml:57:1: [error] trailing spaces (trailing-spaces) + file.yml:60:3: [error] wrong indentation: expected 4 but found 2 (indentation) + +If you have a custom linting configuration file (see :doc:`how to configure +yamllint `), it can be passed to yamllint using the ``-c`` +option: + +:: + + yamllint -c ~/myconfig file.yml + +.. note:: + + If you have a ``.yamllint`` file in your working directory, it will be + automatically loaded as configuration by yamllint. + +.. rubric:: Footnotes + +.. [#colored-output] The default output format is colored and inspired by + `eslint `_, a great linting tool for Javascript. diff --git a/docs/rules.rst b/docs/rules.rst new file mode 100644 index 0000000..d71d0ae --- /dev/null +++ b/docs/rules.rst @@ -0,0 +1,90 @@ +Rules +===== + +When linting a document with yamllint, a series of rules (such as +``line-length``, ``trailing-spaces``, etc.) are checked against. + +A :doc:`configuration file ` can be used to enable or disable +these rules, to set their level (*error* or *warning*), but also to tweak their +options. + +This page describes the rules and their options. + +.. contents:: List of rules + :local: + :depth: 1 + +braces +------ + +.. automodule:: yamllint.rules.braces + +brackets +-------- + +.. automodule:: yamllint.rules.brackets + +colons +------ + +.. automodule:: yamllint.rules.colons + +commas +------ + +.. automodule:: yamllint.rules.commas + +comments +-------- + +.. automodule:: yamllint.rules.comments + +comments-indentation +-------------------- + +.. automodule:: yamllint.rules.comments_indentation + +document-end +------------ + +.. automodule:: yamllint.rules.document_end + +document-start +-------------- + +.. automodule:: yamllint.rules.document_start + +empty-lines +----------- + +.. automodule:: yamllint.rules.empty_lines + +hyphens +------- + +.. automodule:: yamllint.rules.hyphens + +indentation +----------- + +.. automodule:: yamllint.rules.indentation + +line-length +----------- + +.. automodule:: yamllint.rules.line_length + +new-line-at-end-of-file +----------------------- + +.. automodule:: yamllint.rules.new_line_at_end_of_file + +new-lines +--------- + +.. automodule:: yamllint.rules.new_lines + +trailing-spaces +--------------- + +.. automodule:: yamllint.rules.trailing_spaces diff --git a/docs/text_editors.rst b/docs/text_editors.rst new file mode 100644 index 0000000..e34dac0 --- /dev/null +++ b/docs/text_editors.rst @@ -0,0 +1,40 @@ +Integration with text editors +============================= + +Most text editors support syntax checking and highlighting, to visually report +syntax errors and warnings to the user. yamllint can be used to syntax-check +YAML source, but a bit of configuration is required depending on your favorite +text editor. + +Vim +--- + +Assuming that the `syntastic `_ plugin +is installed, add to your ``.vimrc``: + +:: + + TODO + +Neovim +------ + +Assuming that the `neomake `_ plugin is +installed, add to your ``.config/nvim/init.vim``: + +:: + + if executable('yamllint') + let g:neomake_yaml_yamllint_maker = { + \ 'args': ['-f', 'parsable'], + \ 'errorformat': '%E%f:%l:%c: [error] %m,%W%f:%l:%c: [warning] %m' } + let g:neomake_yaml_enabled_makers = ['yamllint'] + endif + +Other text editors +------------------ + +.. rubric:: Help wanted! + +Your favorite text editor is not listed here? Help us improve by adding a +section (by opening a pull-request or issue on GitHub). diff --git a/yamllint/__init__.py b/yamllint/__init__.py index 65c73d3..97cae74 100644 --- a/yamllint/__init__.py +++ b/yamllint/__init__.py @@ -25,8 +25,8 @@ APP_NAME = 'yamllint' APP_VERSION = '0.4.0' APP_DESCRIPTION = 'A linter for YAML files.' -__author__ = 'Adrien Vergé' -__copyright__ = 'Copyright 2016, Adrien Vergé' +__author__ = u'Adrien Vergé' +__copyright__ = u'Copyright 2016, Adrien Vergé' __license__ = 'GPLv3' __version__ = APP_VERSION