Skip to content

Commit 733c3e6

Browse files
committed
Update to include spelling check.
1 parent 7868914 commit 733c3e6

File tree

6 files changed

+25
-7
lines changed

6 files changed

+25
-7
lines changed

CHANGES.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ Change log for ``distlib``
66

77
Released: Not yet.
88

9+
- markers
10+
11+
- Use version comparison logic for python_full_version. Thanks to Albert
12+
Peschar for the patch.
13+
914
0.3.6
1015
~~~~~
1116

docs/Makefile

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ PAPEROPT_a4 = -D latex_paper_size=a4
1212
PAPEROPT_letter = -D latex_paper_size=letter
1313
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1414

15-
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
15+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest remote
1616

1717
help:
1818
@echo "Please use \`make <target>' where <target> is one of"
@@ -41,6 +41,16 @@ html:
4141
@echo
4242
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
4343

44+
apidocs: html
45+
mkdir -p $(BUILDDIR)/html/apidocs
46+
pdoc -o $(BUILDDIR)/html/apidocs --no-show-source --logo https://www.red-dove.com/assets/img/rdclogo.gif ../distlib
47+
48+
remote:
49+
rsync -avz $(BUILDDIR)/html/* vopal:~/apps/rdc_docs/distlib
50+
51+
spelling:
52+
$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)
53+
4454
dirhtml:
4555
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
4656
@echo

docs/conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525

2626
# Add any Sphinx extension module names here, as strings. They can be extensions
2727
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.imgmath', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']
28+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.imgmath', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinxcontrib.spelling'
29+
]
2930

3031
# Add any paths that contain templates here, relative to this directory.
3132
templates_path = ['_templates']
@@ -86,6 +87,8 @@
8687
# A list of ignored prefixes for module index sorting.
8788
#modindex_common_prefix = []
8889

90+
spelling_lang='en_GB'
91+
spelling_word_list_filename='spelling_wordlist.txt'
8992

9093
# -- Options for HTML output ---------------------------------------------------
9194

docs/internals.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,7 @@ to refine its behaviour:
615615

616616
* ``force`` to indicate when scripts should be copied from source to target
617617
even when timestamps show the target is up to date.
618-
* ``set_mode`` to indicate whether, on Posix, the execute mode bits should be
618+
* ``set_mode`` to indicate whether, on POSIX, the execute mode bits should be
619619
set on the target script.
620620

621621
.. _flag-formats:

docs/reference.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@ Classes
583583

584584
.. attribute:: set_mode
585585

586-
Whether, on Posix, the scripts should have their execute mode set.
586+
Whether, on POSIX, the scripts should have their execute mode set.
587587

588588
.. attribute:: script_template
589589

@@ -1736,7 +1736,7 @@ Functions
17361736

17371737
.. function:: interpret(marker, execution_context=None)
17381738

1739-
This function returns the result of interpreting an environment marker in aptional
1739+
This function returns the result of interpreting an environment marker in optional
17401740
execution context, which is used for name lookups.
17411741

17421742

docs/tutorial.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Distlib is a pure-Python library. You should be able to install it using::
1818
pip install distlib
1919

2020
for installing ``distlib`` into a virtualenv or other directory where you have
21-
write permissions. On Posix platforms, you may need to invoke using ``sudo``
21+
write permissions. On POSIX platforms, you may need to invoke using ``sudo``
2222
if you need to install ``distlib`` in a protected location such as your system
2323
Python's ``site-packages`` directory.
2424

@@ -79,7 +79,7 @@ painfully slow. To skip tests that might be sometimes slow, set the
7979

8080
$ SKIP_SLOW=1 PYTHONHASHSEED=0 python tests/test_all.py
8181

82-
on Posix, or::
82+
on POSIX, or::
8383

8484
C:\> set SKIP_SLOW=1
8585
C:\> set PYTHONHASHSEED=0

0 commit comments

Comments
 (0)