Skip to content

Commit

Permalink
Update to use exclude_patterns
Browse files Browse the repository at this point in the history
The exclude_patterns setting replaces exclude_trees and unused_docs,
which modern versions of Sphinx no longer support.  Since
exclude_patterns was added in Sphinx 1.0, document that version as a
requirement.

This change fixes warnings about unlinked documents.
  • Loading branch information
ojwb committed Apr 23, 2016
1 parent baf512d commit 1a47fb9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ once ready.
You will need the Sphinx documentation tool installed to process the
documentation. Confusingly there are several open source projects called
"Sphinx" - see http://sphinx-doc.org/install.html for tips on installing
the one you want. We aren't certain exactly what version is needed - it
seems Sphinx 0.6.4 is too old but 1.1.3 is new enough.
the one you want. We aren't certain exactly what version is needed - at
least Sphinx 1.0.0 is needed, but the oldest we've actually tested with
recently was Sphinx 1.1.3.

You can generate versions for different programming languages (with translated
examples and adjustments to the text). For full details see `make help`
Expand Down
9 changes: 3 additions & 6 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,9 @@
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of documents that shouldn't be included in the build.
#unused_docs = []

# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = ['_build', 'attic', 'language_specific']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'attic', 'language_specific']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
Expand Down

0 comments on commit 1a47fb9

Please sign in to comment.