[Notes] [Git][BuildStream/buildstream][chandan/toxify] 2 commits: Move a

Chandan Singh pushed to branch chandan/toxify at BuildStream / buildstream

Commits:

13f10826

by Chandan Singh at 2018-12-30T18:57:33Z

Move all requirements files into "tools" directory

These new `.in` and `.txt` are making the repository look very
cluttered. Move them to a separate `tools` directory to make it look a
bit cleaner.

6cbc779b

by Chandan Singh at 2018-12-30T19:16:24Z

Move sphinx build functionality to tox

Currently the CI and the docs both have to duplicate the same inforation
about how to gather dependencies etc, and have to use hacky ways to run
them.

Add a new `docs` environment to our tox setup so that building docs is
as simple as running `tox -e docs`.

11 changed files:

.gitlab-ci.yml
CONTRIBUTING.rst
MANIFEST.in
setup.py
dev-requirements.in → tools/dev-requirements.in
dev-requirements.txt → tools/dev-requirements.txt
plugin-requirements.in → tools/plugin-requirements.in
plugin-requirements.txt → tools/plugin-requirements.txt
requirements.in → tools/requirements.in
requirements.txt → tools/requirements.txt
tox.ini

Changes:

.gitlab-ci.yml

@@ -162,16 +162,12 @@ tests-fedora-missing-deps:
  #       as it will significantly grow the backing image.
  docs:
    stage: test
 +  variables:
 +    BST_FORCE_SESSION_REBUILD: 1
    script:
    - export BST_SOURCE_CACHE="$(pwd)/cache/integration-cache/sources"
 -  # Currently sphinx_rtd_theme does not support Sphinx >1.8, this breaks search functionality
 -  - pip3 install sphinx==1.7.9
 -  - pip3 install sphinx-click
 -  - pip3 install sphinx_rtd_theme
 -  - cd dist && ./unpack.sh && cd buildstream
 -  - make BST_FORCE_SESSION_REBUILD=1 -C doc
 -  - cd ../..
 -  - mv dist/buildstream/doc/build/html public
 +  - tox -e docs
 +  - mv doc/build/html public
    except:
    - schedules
    artifacts:

CONTRIBUTING.rst

@@ -1222,27 +1222,13 @@ For further information about using the reStructuredText with sphinx, please see
  Building Docs
  ~~~~~~~~~~~~~
 -The documentation build is not integrated into the ``setup.py`` and is
 -difficult (or impossible) to do so, so there is a little bit of setup
 -you need to take care of first.
+-
 -Before you can build the BuildStream documentation yourself, you need
 -to first install ``sphinx`` along with some additional plugins and dependencies,
 -using pip or some other mechanism::
+-
 -  # Install sphinx
 -  pip3 install --user sphinx
+-
 -  # Install some sphinx extensions
 -  pip3 install --user sphinx-click
 -  pip3 install --user sphinx_rtd_theme
+-
 -  # Additional optional dependencies required
 -  pip3 install --user arpy
 +Before you can build the docs, you will end to ensure that you have installed
 +the required :ref:`buid dependencies <contributing_build_deps>` as mentioned
 +in the testing section above.
  To build the documentation, just run the following::
 -  make -C doc
 +  tox -e docs
  This will give you a ``doc/build/html`` directory with the html docs which
  you can view in your browser locally to test.
@@ -1260,9 +1246,10 @@ will make the docs build reuse already downloaded sources::
    export BST_SOURCE_CACHE=~/.cache/buildstream/sources
 -To force rebuild session html while building the doc, simply build the docs like this::
 +To force rebuild session html while building the doc, simply run `tox` with the
 +``BST_FORCE_SESSION_REBUILD`` environment variable set, like so::
 -  make BST_FORCE_SESSION_REBUILD=1 -C doc
 +  env BST_FORCE_SESSION_REBUILD=1 tox -e docs
  Man pages
@@ -1478,6 +1465,8 @@ The elaborate documentation for pytest can be found here: http://doc.pytest.org/
  Don't get lost in the docs if you don't need to, follow existing examples instead.
 +.. _contributing_build_deps:
++
  Installing build dependencies
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  Some of BuildStream's dependencies have non-python build dependencies. When

MANIFEST.in

@@ -32,12 +32,12 @@ include .pylintrc
  recursive-include buildstream/_protos *.proto
  # Requirements files
 -include requirements.in
 -include requirements.txt
 -include dev-requirements.in
 -include dev-requirements.txt
 -include plugin-requirements.in
 -include plugin-requirements.txt
 +include tools/requirements.in
 +include tools/requirements.txt
 +include tools/dev-requirements.in
 +include tools/dev-requirements.txt
 +include tools/plugin-requirements.in
 +include tools/plugin-requirements.txt
  # Versioneer
  include versioneer.py

setup.py

@@ -270,10 +270,10 @@ def get_cmdclass():
  #####################################################
  #               Gather requirements                 #
  #####################################################
 -with open('dev-requirements.in') as dev_reqs:
 +with open('tools/dev-requirements.in') as dev_reqs:
      dev_requires = dev_reqs.read().splitlines()
 -with open('requirements.in') as install_reqs:
 +with open('tools/requirements.in') as install_reqs:
      install_requires = install_reqs.read().splitlines()
  #####################################################

dev-requirements.in → tools/dev-requirements.in

dev-requirements.txt → tools/dev-requirements.txt

plugin-requirements.in → tools/plugin-requirements.in

plugin-requirements.txt → tools/plugin-requirements.txt

requirements.in → tools/requirements.in

requirements.txt → tools/requirements.txt

tox.ini

  [tox]
 -envlist = py35,py36,py37
 +envlist = py35,py36,py37,docs
  skip_missing_interpreters = true
  [testenv]
  commands = pytest {posargs}
  deps =
 -    -rrequirements.txt
 -    -rdev-requirements.txt
 -    -rplugin-requirements.txt
 +    -rtools/requirements.txt
 +    -rtools/dev-requirements.txt
 +    -rtools/plugin-requirements.txt
  passenv =
      GI_TYPELIB_PATH
 +    BST_FORCE_BACKEND
++
 +[testenv:docs]
 +commands=
 +    make -C doc
 +# Currently sphinx_rtd_theme does not support Sphinx >1.8, this breaks search functionality
 +deps =
 +    sphinx==1.7.9
 +    sphinx-click
 +    sphinx_rtd_theme
 +    -rtools/requirements.txt
 +    -rtools/plugin-requirements.txt
 +passenv =
 +    BST_SOURCE_CACHE
 +    BST_FORCE_SESSION_REBUILD

[Notes] [Git][BuildStream/buildstream][chandan/toxify] 2 commits: Move all requirements files into "tools" directory

Chandan Singh pushed to branch chandan/toxify at BuildStream / buildstream

Commits:

11 changed files:

Changes: