Skip to content

Commit

Permalink
remove sphinx spelling module
Browse files Browse the repository at this point in the history
  • Loading branch information
alejandrogr committed Sep 22, 2017
1 parent d6c44e2 commit 2ec70ba
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 40 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ install:

.PHONY: docs
docs: ## generate and shows documentation
@make -C docs spelling html
@make -C docs html

.PHONY: run
run: ## local run the app
Expand Down
38 changes: 15 additions & 23 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# deeptracy worker documentation build configuration file.
# deeptracy documentation build configuration file.
#
# This file is execfile()d with the current workery set to its
# This file is execfile()d with the current y set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
Expand All @@ -12,8 +12,8 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another workery,
# add these workeries to sys.path here. If the workery is relative to the
# If extensions (or modules to document with autodoc) are in another y,
# add these ies to sys.path here. If the y is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import sys
Expand All @@ -33,11 +33,10 @@
'sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinxcontrib.spelling'
'sphinx.ext.viewcode'
]

# Add any paths that contain templates here, relative to this workery.
# Add any paths that contain templates here, relative to this y.
templates_path = ['_templates']

# extra parsers
Expand All @@ -53,7 +52,7 @@
master_doc = 'index'

# General information about the project.
project = 'deeptracy worker'
project = 'deeptracy '
copyright = '2017, BBVA'
author = 'BBVA'

Expand All @@ -73,8 +72,8 @@
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source workery, that match files and
# workeries to ignore when looking for source files.
# List of patterns, relative to source y, that match files and
# ies to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

Expand All @@ -98,7 +97,7 @@
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this workery. They are copied after the builtin static files,
# relative to this y. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

Expand All @@ -120,7 +119,7 @@
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'deeptracyworkerdoc'
htmlhelp_basename = 'deeptracydoc'

# -- Options for LaTeX output ---------------------------------------------

Expand All @@ -146,7 +145,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'deeptracyworker.tex', 'deeptracy worker Documentation',
(master_doc, 'deeptracy.tex', 'deeptracy Documentation',
'BBVA', 'manual'),
]

Expand All @@ -155,7 +154,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'deeptracyworker', 'deeptracy worker Documentation',
(master_doc, 'deeptracy', 'deeptracy Documentation',
[author], 1)
]

Expand All @@ -165,14 +164,7 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'deeptracyworker', 'deeptracy worker Documentation',
author, 'deeptracyworker', 'One line description of project.',
(master_doc, 'deeptracy', 'Deeptracy Documentation',
author, 'deeptracy', 'Spot security vulnerabilities in your project dependencies',
'Miscellaneous'),
]

# File containing a list of words known to be spelled correctly
# but that do not appear in the language dictionary
spelling_word_list_filename = 'spelling_word_list.txt'

# Show suggestions for misspelled words
spelling_show_suggestions = True
15 changes: 0 additions & 15 deletions docs/spelling_word_list.txt

This file was deleted.

1 change: 0 additions & 1 deletion requirements_dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
bumpversion==0.5.3
wheel==0.29.0
sphinx==1.6.3
sphinxcontrib-spelling==2.3.0
recommonmark==0.4.0

0 comments on commit 2ec70ba

Please sign in to comment.