Skip to content

Commit

Permalink
Fixing docs-rtd tox rule.
Browse files Browse the repository at this point in the history
It was previously broken because module verification assumed
the docs were built in the _build directory.
  • Loading branch information
dhermes committed Aug 23, 2016
1 parent 9b3a082 commit a7927d5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
17 changes: 12 additions & 5 deletions scripts/verify_included_modules.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
BASE_DIR = os.path.abspath(
os.path.join(os.path.dirname(__file__), '..'))
DOCS_DIR = os.path.join(BASE_DIR, 'docs')
OBJECT_INVENTORY_RELPATH = os.path.join('_build', 'html', 'objects.inv')
IGNORED_PREFIXES = ('test_', '_')
IGNORED_MODULES = frozenset([
'gcloud.__init__',
Expand Down Expand Up @@ -118,11 +117,18 @@ def get_public_modules(path, base_package=None):
return result


def main():
"""Main script to verify modules included."""
def main(build_root='_build'):
"""Main script to verify modules included.
:type build_root: str
:param build_root: The root of the directory where docs are built into.
Defaults to ``_build``.
"""
object_inventory_relpath = os.path.join(build_root, 'html', 'objects.inv')

mock_uri = ''
inventory = fetch_inventory(SphinxApp, mock_uri,
OBJECT_INVENTORY_RELPATH)
object_inventory_relpath)
sphinx_mods = set(inventory['py:module'].keys())

library_dir = os.path.join(BASE_DIR, 'gcloud')
Expand Down Expand Up @@ -150,4 +156,5 @@ def main():


if __name__ == '__main__':
main()
_, build_root = sys.argv
main(build_root=build_root)
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ basepython =
commands =
python -c "import shutil; shutil.rmtree('docs/_build', ignore_errors=True)"
sphinx-build -W -b html -d docs/_build/doctrees docs docs/_build/html
python {toxinidir}/scripts/verify_included_modules.py
python {toxinidir}/scripts/verify_included_modules.py _build
deps =
{[testenv]deps}
{[docs]deps}
Expand Down Expand Up @@ -99,7 +99,7 @@ basepython = {[testenv:docs]basepython}
commands =
python -c "import shutil; shutil.rmtree('docs/_build_rtd', ignore_errors=True)"
sphinx-build -W -b html -d docs/_build_rtd/doctrees docs docs/_build_rtd/html
python {toxinidir}/scripts/verify_included_modules.py
python {toxinidir}/scripts/verify_included_modules.py _build_rtd
deps =
{[testing]deps}
{[docs]deps}
Expand Down

0 comments on commit a7927d5

Please sign in to comment.