[ckan-changes] [ckan/ckan] 75659d: Speeds up sphinx test by only testing changes

GitHub noreply at github.com
Fri Jun 15 10:56:45 UTC 2018


  Branch: refs/heads/speed-up-sphinx-test
  Home:   https://github.com/ckan/ckan
  Commit: 75659d48463ad2e914811219ae5062898937f724
      https://github.com/ckan/ckan/commit/75659d48463ad2e914811219ae5062898937f724
  Author: Ross Jones <ross at mailbolt.com>
  Date:   2018-06-15 (Fri, 15 Jun 2018)

  Changed paths:
    M ckan/tests/test_coding_standards.py

  Log Message:
  -----------
  Speeds up sphinx test by only testing changes

The `test_building_the_docs` test was rebuilding all of the
documentation from scratch as a test - on my computer, this took about
35 seconds.

There is no need to build the documentation from scratch, by removing
the all-files and fresh-env parameters only documentation for files that
have changed are rebuilt.

Removing these two parameters makes the test now take 7s, about 10s if
you change a file containing documentation.  For multiple full runs for
development this saved time adds up.


  Commit: 7c7e397e377c903d4e929a19ee13a13ffad67470
      https://github.com/ckan/ckan/commit/7c7e397e377c903d4e929a19ee13a13ffad67470
  Author: Ross Jones <ross at mailbolt.com>
  Date:   2018-06-15 (Fri, 15 Jun 2018)

  Changed paths:
    M dev-requirements.txt

  Log Message:
  -----------
  Update version of sphinx used

Sphinx 1.7.5 seems (anecdotally) marginally faster than 1.7.1


Compare: https://github.com/ckan/ckan/compare/75659d48463a^...7c7e397e377c
      **NOTE:** This service been marked for deprecation: https://developer.github.com/changes/2018-04-25-github-services-deprecation/

      Functionality will be removed from GitHub.com on January 31st, 2019.


More information about the ckan-changes mailing list