diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..c88db2a --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +# doc build requirements +sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD +sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +sphinxcontrib-httpdomain>=1.3.0 # BSD +reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 4e94e59..f616817 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -69,15 +69,29 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project +# Example configuration for intersphinx: refer to the Python standard library. +#intersphinx_mapping = {'http://docs.python.org/': None} + +# -- Options for LaTeX output ------------------------------------------------- + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ - ('index', - '%s.tex' % project, - u'%s Documentation' % project, + ('index', 'doc-muranopkgcheck.tex', u'Murano pkg check Documentation', u'OpenStack Foundation', 'manual'), ] +latex_domain_indices = False -# Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} +latex_elements = { + 'makeindex': '', + 'printindex': '', + 'preamble': r'\setcounter{tocdepth}{3}', + 'maxlistdepth': '10', +} + +# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664 +latex_use_xindy = False + +# Disable smartquotes, they don't work in latex +smartquotes_excludes = {'builders': ['latex']} diff --git a/doc/source/index.rst b/doc/source/index.rst index f71784d..bcc37cc 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,10 +17,11 @@ Contents: usage contributing -Indices and tables -================== +.. only:: html -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + Indices and tables + ================== + * :ref:`genindex` + * :ref:`modindex` + * :ref:`search` diff --git a/doc/source/readme.rst b/doc/source/readme.rst index a6210d3..b694cae 100644 --- a/doc/source/readme.rst +++ b/doc/source/readme.rst @@ -1 +1,32 @@ -.. include:: ../../README.rst +====================== +About murano-pkg-check +====================== + +Murano package validator tool + +After checking out tool from repository easiest method to run tool is to run + +.. code-block:: console + + tox -e venv -- murano-pkg-check -h + +This command will display help for murano-pkg-validator + +If you installed it from PYPI you can use: +.. code-block:: console + + murano-pkg-check -h + +To run validator in directory apache-app just run: +.. code-block:: console + + murano-pkg-check apache-app + +It will print all errors there are on package. + +.. code-block:: console + + murano-pkg-check --discovery murano-apps + +Will search for all packages under directory `murano-apps`. It will print all +errors and warnings for all packages found. diff --git a/tox.ini b/tox.ini index 575c0e7..18b6418 100644 --- a/tox.ini +++ b/tox.ini @@ -37,10 +37,21 @@ commands = [testenv:docs] basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt commands = python tools/gen_errors.py python setup.py build_sphinx +[testenv:pdf-docs] +basepython = python3 +deps = {[testenv:docs]deps} +whitelist_externals = + make +commands = + sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf + + [testenv:releasenotes] basepython = python3 commands =