Merge pull request #33 from wikimedia/docs-test-ci

Use documentation builds as part of CI testing
wikimedia · Sep 16, 2019 · 1e440eb · 1e440eb
2 parents 53dc135 + 16e5a1a
commit 1e440eb
Show file tree

Hide file tree

Showing 10 changed files with 9 additions and 138 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -10,12 +10,16 @@ addons:
 # command to install dependencies
 install:
   - pip install -r requirements.txt
+  - pip install -r docs/requirements.txt
   - python setup.py install
   - pip install twine
   - pip install flake8
+  - python -m nltk.downloader stopwords
 
 script:
   - flake8 . --ignore=E722
+  - sphinx-build -anW -b html docs dist/docs
+  - sphinx-build -b linkcheck docs dist/docs
 
 after_success:
   - coverage report

diff --git a/docs/conf.py b/docs/conf.py
@@ -70,4 +70,4 @@
 # 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 = []
diff --git a/docs/reference/draftquality.rst b/docs/reference/draftquality.rst
@@ -1,4 +1,7 @@
 .. _api_reference:
+
+:orphan:
+
 draftquality package
 ====================
 
@@ -8,32 +11,3 @@ Subpackages
 .. toctree::
 
    draftquality.feature_lists
-   draftquality.utilities
-
-Submodules
-----------
-
-draftquality.about module
--------------------------
-
-.. automodule:: draftquality.about
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-draftquality.draftquality module
---------------------------------
-
-.. automodule:: draftquality.draftquality
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: draftquality
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/reference/draftquality.utilities.rst b/docs/reference/draftquality.utilities.rst
diff --git a/docs/reference/modules.rst b/docs/reference/modules.rst
diff --git a/draftquality/__init__.py b/draftquality/__init__.py
@@ -5,10 +5,7 @@
 
 In this package, you'll find the
 :mod:`feature lists <draftquality.feature_lists>` used to train models
-for the supported wiki.  There's a set of
-:mod:`command-line utilities <draftquality.utilities>`
-that are used to perform data pipeline operations specific to training and
-testing a quality model.
+for the supported wiki.
 
 See the :ref:`API Reference <api_reference>` for low level details.
 """

diff --git a/draftquality/draftquality.py b/draftquality/draftquality.py
diff --git a/draftquality/utilities/__init__.py b/draftquality/utilities/__init__.py
diff --git a/draftquality/utilities/fetch_text.py b/draftquality/utilities/fetch_text.py
diff --git a/setup.py b/setup.py
@@ -24,11 +24,6 @@ def requirements(fname):
     url=__url__,  # noqa
     license=__license__, # noqa
     packages=find_packages(),
-    entry_points={
-        'console_scripts': [
-            'editquality=draftquality.draftquality:main'
-        ],
-    },
     long_description=read('README.md'),
     install_requires=requirements('requirements.txt'),
     classifiers=[