Skip to content

Remove unnecessary docutils dependency #257

Closed

Description

@pekkaklarck

This library currently has following dependencies:

decorator >= 3.3.2
selenium >= 2.32.0
robotframework >= 2.6.0
docutils >= 0.8.1

Three first are actually used by the library, but docutils is only used for compiling README.rest and other reStructuredText files to HTML by doc/generate_readmes.py and doc/buildhtml.py. This is just a developer/packager activity and thus users don't really need docutils for anything.

I would like to remove the docutils dependency to make it easier to document what dependencies are needed in manual installation (see #255). Avoiding an unnecessary download when using pip wouldn't obviously hurt either.

I'm not certain is compiling reST to HTML really needed in general. Users looking at source probably are fine with *.rst source files and in GitHub (and PyPI #254) these files are formatted automatically. If the compilation isn't needed anymore, then the need for docutils obviously goes away. If there is a use case for the compilation, I would still be more than willing to remove the docutils dependency from users. If we want to be helpful for the developer running the aforementioned compilation scripts, we can change them to import docutils like this:

try:
    import docutils
except ImportError:
    raise ImportError('Importing `docutils` failed. Install it with `pip install docutils`.')

Activity

  1. modified the milestones: 1.7, on Apr 24, 2015
  2. modified the milestones: , on May 5, 2015
  3. removed this from the milestone on Aug 11, 2015
  4. added this to the v1.8 milestone on Aug 8, 2016
  5. self-assigned this
    on Aug 8, 2016
  6. aaltat commented on Aug 8, 2016

    @aaltat
    Contributor

    @pekkaklarck Would you time to look the pull request to fix this.

  7. added a commit that references this issue on Aug 8, 2016
    e96af7a
  8. added a commit that references this issue on Oct 17, 2016
    562bc6d
  9. added a commit that references this issue on Oct 18, 2016
    7319e76
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions