From abb234e1f23503fb50b4a2d1cddb76abee7d2e64 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 28 Jan 2018 18:07:52 +0100 Subject: [PATCH] Fix docs build Fixes for docs build: * Use doc/requirements to follow changes in OpenStack CI for the docs building, add a tox environment for this. * Remove reference to "project's download page", the link was removed in change I2db594d279e1229e5b1600cecad86fe0c3612115 and now we have a dead link that errors building if warnings are treated as errors. * Change I2db594d279e1229e5b1600cecad86fe0c3612115 added a column for DB2 header but not for any entries, enhance table with extra column. This fixes building of the table if warnings are treated as errors. * Update to sphinx 1.6.x since that is what is used in OpenStack CI job, remove issuetracker, it does not work with sphinx 1.6 anymore. * Disable html_static_path - the content does not exist * Use python3 for docs building Change-Id: I76ee4d6dc45f9b04115f093951ae8b745f3ac026 --- doc/requirements.txt | 1 + doc/source/conf.py | 5 +++-- doc/source/download.rst | 2 +- doc/source/index.rst | 10 +++++++++- tox.ini | 5 +++++ 5 files changed, 19 insertions(+), 4 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..c019c60 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1 @@ +sphinx>=1.6.2,!=1.6.6 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index f8f609c..91e824e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -28,7 +28,8 @@ sys.path.append(os.path.dirname(os.path.abspath('.'))) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinxcontrib.issuetracker'] +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.intersphinx'] # link to sqlalchemy docs intersphinx_mapping = { @@ -128,7 +129,7 @@ html_style = 'default.css' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/doc/source/download.rst b/doc/source/download.rst index c9e2bec..e43c683 100644 --- a/doc/source/download.rst +++ b/doc/source/download.rst @@ -2,7 +2,7 @@ Download -------- You can get the latest version of SQLAlchemy Migrate from the -`project's download page`_, the `cheese shop`_, pip_ or via easy_install_:: +the `cheese shop`_, pip_ or via easy_install_:: $ easy_install sqlalchemy-migrate diff --git a/doc/source/index.rst b/doc/source/index.rst index c143b77..a353ebb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -55,7 +55,7 @@ Dialect support .. list-table:: :header-rows: 1 - :widths: 25 10 10 10 10 10 11 + :widths: 25 10 10 10 10 10 11 10 * - Operation / Dialect - :ref:`sqlite ` @@ -72,6 +72,7 @@ Dialect support - yes - no - not supported + - unknown * - :ref:`ALTER TABLE RENAME COLUMN ` - yes (workaround) [#1]_ - yes @@ -79,6 +80,7 @@ Dialect support - yes - yes - not supported + - unknown * - :ref:`ALTER TABLE ADD COLUMN ` - yes (workaround) [#2]_ - yes @@ -86,6 +88,7 @@ Dialect support - yes - yes - not supported + - unknown * - :ref:`ALTER TABLE DROP COLUMN ` - yes (workaround) [#1]_ - yes @@ -93,6 +96,7 @@ Dialect support - yes - yes - not supported + - unknown * - :ref:`ALTER TABLE ALTER COLUMN ` - yes (workaround) [#1]_ - yes @@ -100,6 +104,7 @@ Dialect support - yes (with limitations) [#3]_ - yes [#4]_ - not supported + - unknown * - :ref:`ALTER TABLE ADD CONSTRAINT ` - partial (workaround) [#1]_ - yes @@ -107,6 +112,7 @@ Dialect support - yes - yes - not supported + - unknown * - :ref:`ALTER TABLE DROP CONSTRAINT ` - partial (workaround) [#1]_ - yes @@ -114,6 +120,7 @@ Dialect support - yes - yes - not supported + - unknown * - :ref:`RENAME INDEX ` - no - yes @@ -121,6 +128,7 @@ Dialect support - yes - yes - not supported + - unknown .. [#1] Table is renamed to temporary table, new table is created followed by diff --git a/tox.ini b/tox.ini index c6c081c..814c33f 100644 --- a/tox.ini +++ b/tox.ini @@ -72,6 +72,11 @@ deps = sqlalchemy>=0.9 [testenv:pep8] commands = flake8 +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build doc/source doc/build/html + [testenv:venv] commands = {posargs}