SF.net SVN: docutils:[9672 ] trunk
milde--- via Docutils-checkins <[email protected]>
| Newsgroups | gmane.text.docutils.cvs |
|---|---|
| Message-ID | <[email protected]> |
Revision: 9672
http://sourceforge.net/p/docutils/code/9672
Author: milde
Date: 2024-05-03 09:48:07 +0000 (Fri, 03 May 2024)
Log Message:
-----------
Scan documentation for trailing whitespace with "pre-commit" hooks.
Remove the exception of documentation sources from the "trailing whitespace"
hook in ".pre-commit-config.yaml" so that commits to a local git-svn repository
will prevent trailing whitespace from slipping into the repository.
Change the Emacs "Local variables" block so that the FORM FEED (^L) character used
to make emacs stop looking for local variables in unrelated text is no longer
a trailing whitespace (and hence not removed by the pre-commit hook),
cf. the docutils-develop thread starting 2024-04-24.
Other trailing whitespace that crept into the repository is removed.
Once at it, also add "mode: rst" (keeping "mode: indented-text" as fallback).
Modified Paths:
--------------
trunk/.pre-commit-config.yaml
trunk/docutils/BUGS.txt
trunk/docutils/FAQ.txt
trunk/docutils/HISTORY.txt
trunk/docutils/README.txt
trunk/docutils/docs/dev/hacking.txt
trunk/docutils/docs/dev/policies.txt
trunk/docutils/docs/dev/pysource.txt
trunk/docutils/docs/dev/release.txt
trunk/docutils/docs/dev/rst/alternatives.txt
trunk/docutils/docs/dev/rst/problems.txt
trunk/docutils/docs/dev/semantics.txt
trunk/docutils/docs/dev/todo.txt
trunk/docutils/docs/dev/website.txt
trunk/docutils/docs/howto/html-stylesheets.txt
trunk/docutils/docs/index.txt
trunk/docutils/docs/peps/pep-0256.txt
trunk/docutils/docs/peps/pep-0257.txt
trunk/docutils/docs/peps/pep-0258.txt
trunk/docutils/docs/peps/pep-0287.txt
trunk/docutils/docs/ref/doctree.txt
trunk/docutils/docs/ref/rst/definitions.txt
trunk/docutils/docs/ref/rst/directives.txt
trunk/docutils/docs/ref/rst/introduction.txt
trunk/docutils/docs/ref/rst/restructuredtext.txt
trunk/docutils/docs/user/emacs.txt
trunk/docutils/docs/user/tools.txt
Modified: trunk/.pre-commit-config.yaml
===================================================================
--- trunk/.pre-commit-config.yaml 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/.pre-commit-config.yaml 2024-05-03 09:48:07 UTC (rev 9672)
@@ -7,9 +7,9 @@
hooks:
- id: check-added-large-files
- id: trailing-whitespace
- exclude: ^(sandbox|docutils/docs)|(.el|.svg|.tex|pseudoxml.txt|test_manpage.py)$
+ exclude: ^sandbox|(.el|.svg|.tex|pseudoxml.txt)$
- id: end-of-file-fixer
- exclude: ^sandbox|(.svg)|docutils/test/data/utf-16-le-sig.txt$
+ exclude: ^sandbox|(.svg|docutils/test/data/utf-16-le-sig.txt)$
- repo: https://github.com/pycqa/flake8
rev: 5.0.4 # Docutils' ``.flake8`` configuration files do not work with Flake8 >=6
Modified: trunk/docutils/BUGS.txt
===================================================================
--- trunk/docutils/BUGS.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/BUGS.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -284,9 +284,11 @@
attribute should be "names"; this is an inconsistency.
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/FAQ.txt
===================================================================
--- trunk/docutils/FAQ.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/FAQ.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -1309,9 +1309,11 @@
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/HISTORY.txt
===================================================================
--- trunk/docutils/HISTORY.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/HISTORY.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -4447,9 +4447,11 @@
.. _<literal>: docs/ref/doctree.html#literal
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/README.txt
===================================================================
--- trunk/docutils/README.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/README.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -393,9 +393,11 @@
.. _Docutils-users: docs/user/mailing-lists.html#docutils-users
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/dev/hacking.txt
===================================================================
--- trunk/docutils/docs/dev/hacking.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/hacking.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -268,10 +268,11 @@
.. |---| unicode:: 8212 .. em-dash
:trim:
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/dev/policies.txt
===================================================================
--- trunk/docutils/docs/dev/policies.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/policies.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -674,10 +674,11 @@
.. _link list: https://docutils.sourceforge.io/docs/user/links.html
.. _docutils-develop: docs/user/mailing-lists.html#docutils-develop
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/dev/pysource.txt
===================================================================
--- trunk/docutils/docs/dev/pysource.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/pysource.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -124,10 +124,11 @@
.. _docutils.dtd: ../ref/docutils.dtd
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
fill-column: 70
End:
Modified: trunk/docutils/docs/dev/release.txt
===================================================================
--- trunk/docutils/docs/dev/release.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/release.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -48,7 +48,7 @@
releaselevel='candidate', # one of 'alpha', 'beta', 'candidate', 'final'
serial=1, # pre-release number (0 for final releases and snapshots)
release=False # True for official releases and pre-releases
- )
+ )
Run tests ::
@@ -64,7 +64,7 @@
* Generate wheel and source-distribution::
python3 -m pip install flit
- python3 -m flit build
+ python3 -m flit build
or ::
@@ -74,13 +74,13 @@
check file sizes: the 0.21.2 wheel was 574K the sdist 2,2M.
* Upload wheel and source to test.pypi.
-
+
Set repository and key in ~/.pypirc with a <server-name> and
password token::
python3 -m twine upload --repository <server-name> dist/*
- Change directory outside of checkout and test in venv.
+ Change directory outside of checkout and test in venv.
NOTE use --pre for prereleases::
python3 -m venv du3 ; cd du3
@@ -95,7 +95,7 @@
if ok ::
deactivate ; cd .. ; rm -r du3
-
+
Test the sdist::
python3 -m venv du3s ; cd du3s
@@ -106,7 +106,7 @@
sdist installation fails with subprocess not finding flit_core .
test.pypi has flit 3.5.1 but installs 0.5 preinstalling flit_core did not work
either ... why.
-
+
postbone sdist test to pypi::
cp -Lr ../docutils-code/docutils/test .
@@ -128,7 +128,7 @@
* Update your source directory.
* Rebuild wheel and source-distribution ::
- python3 -m flit build
+ python3 -m flit build
* Now upload to pypi::
@@ -191,10 +191,11 @@
* docutils/HISTORY.txt: add title "Changes Since #.#"
* run sandbox/infrastructure/docutils-update.local
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/dev/rst/alternatives.txt
===================================================================
--- trunk/docutils/docs/dev/rst/alternatives.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/rst/alternatives.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -3062,7 +3062,7 @@
be useful as a shorthand for the directive.
It's common practice to use ^L before Emacs "Local Variables"
- lists::
+ lists (to prevent misinterpretation of unrelated text)::
^L
..
@@ -3203,10 +3203,11 @@
.. _object references:
../todo.html#object-numbering-and-object-references
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/dev/rst/problems.txt
===================================================================
--- trunk/docutils/docs/dev/rst/problems.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/rst/problems.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -863,10 +863,11 @@
.. _reStructuredText Markup Specification:
../../ref/rst/restructuredtext.html
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/dev/semantics.txt
===================================================================
--- trunk/docutils/docs/dev/semantics.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/semantics.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -111,10 +111,11 @@
.. _iPhrase Python documentation conventions:
https://mail.python.org/pipermail/doc-sig/2001-May/001840.html
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/dev/todo.txt
===================================================================
--- trunk/docutils/docs/dev/todo.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/todo.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -2344,24 +2344,24 @@
* Set HTML "width" and "height" attributes with the original size (read
from the image) to prevent *layout shifts*:
-
+
Layout shifts are very disrupting to the user, especially if you have
already started reading the article and suddenly you are thrown off
by a jolt of movement, and you have to find your place again.
-
+
-- `Setting Height And Width On Images Is Important Again`__
-
+
- If there are no size options (``:widht:``, ``:height:``, ``:scale:``)
- in the "image" directive and
+ in the "image" directive and
the image is *local* and can be read and interpreted by PIM.
(if not, silently skip).
-
+
- Alternatively, if the only size option is ``:scale: 100%`` and the
image can be read with urllib (*opt-in* for the "costly" variant).
__ https://www.smashingmagazine.com/2020/03/setting-height-width-images-important-again/.
-
+
PEP/HTML Writer
===============
@@ -2857,10 +2857,11 @@
.. _transforms: ../api/transforms.html
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/dev/website.txt
===================================================================
--- trunk/docutils/docs/dev/website.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/dev/website.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -99,10 +99,11 @@
from the web site. Files and directories must be manually removed from
sourceforge.net (under ``/home/project-web/docutils/htdocs/``).
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/howto/html-stylesheets.txt
===================================================================
--- trunk/docutils/docs/howto/html-stylesheets.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/howto/html-stylesheets.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -86,10 +86,11 @@
.. _stylesheet collection: ../../../sandbox/stylesheets/
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/index.txt
===================================================================
--- trunk/docutils/docs/index.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/index.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -50,10 +50,10 @@
.. class:: details
-There's a lot of overlap between these groups.
+There's a lot of overlap between these groups.
Most (perhaps all) developers are also end-users.
- Core-developers are also client-developers, and may also
- be component-developers in other projects.
+ Core-developers are also client-developers, and may also
+ be component-developers in other projects.
Component-developers are also client-developers.
@@ -63,24 +63,24 @@
These files are for all `Docutils stakeholders`_. They are kept at the
top level of the Docutils project directory.
-`README <../README.html>`_:
+`README <../README.html>`_:
Project overview: quick-start, requirements,
installation, and usage.
-`COPYING <../COPYING.html>`_:
- Conditions for Docutils redistribution,
+`COPYING <../COPYING.html>`_:
+ Conditions for Docutils redistribution,
with links to licenses.
`FAQ <../FAQ.html>`_:
Docutils Frequently Asked Questions. If you have a question or issue,
there's a good chance it's already answered here.
-`BUGS <../BUGS.html>`_:
+`BUGS <../BUGS.html>`_:
A list of known bugs, and how to report a bug.
-`RELEASE-NOTES <../RELEASE-NOTES.html>`_:
+`RELEASE-NOTES <../RELEASE-NOTES.html>`_:
Summary of the major changes in recent releases and
notice of future incompatible changes.
-`HISTORY <../HISTORY.html>`_:
+`HISTORY <../HISTORY.html>`_:
Detailed change history log.
-`THANKS <../THANKS.html>`_:
+`THANKS <../THANKS.html>`_:
Acknowledgements.
@@ -231,10 +231,11 @@
<dev/rst/alternatives.html>`__
* `Problems With StructuredText <dev/rst/problems.html>`__
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/peps/pep-0256.txt
===================================================================
--- trunk/docutils/docs/peps/pep-0256.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/peps/pep-0256.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -293,10 +293,11 @@
Doc-SIG`_. Thanks to all members past & present.
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/peps/pep-0257.txt
===================================================================
--- trunk/docutils/docs/peps/pep-0257.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/peps/pep-0257.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -318,10 +318,11 @@
Thanks to all members past and present.
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
fill-column: 70
sentence-end-double-space: t
Modified: trunk/docutils/docs/peps/pep-0258.txt
===================================================================
--- trunk/docutils/docs/peps/pep-0258.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/peps/pep-0258.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -1024,10 +1024,11 @@
Doc-SIG`_. Thanks to all members past & present.
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/peps/pep-0287.txt
===================================================================
--- trunk/docutils/docs/peps/pep-0287.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/peps/pep-0287.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -805,10 +805,11 @@
Special thanks to all members past & present of the Python Doc-SIG_.
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/ref/doctree.txt
===================================================================
--- trunk/docutils/docs/ref/doctree.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/ref/doctree.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -5562,8 +5562,8 @@
.. _table of compatible image formats: rst/directives.html#image-formats
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
indent-tabs-mode: nil
Modified: trunk/docutils/docs/ref/rst/definitions.txt
===================================================================
--- trunk/docutils/docs/ref/rst/definitions.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/ref/rst/definitions.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -171,10 +171,11 @@
.. _s5defs.txt: ../../../docutils/parsers/rst/include/s5defs.txt
.. _S5/HTML slide shows: ../../user/slide-shows.html
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/ref/rst/directives.txt
===================================================================
--- trunk/docutils/docs/ref/rst/directives.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/ref/rst/directives.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -2314,10 +2314,11 @@
.. _<warning>: ../doctree.html#warning
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/ref/rst/introduction.txt
===================================================================
--- trunk/docutils/docs/ref/rst/introduction.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/ref/rst/introduction.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -303,10 +303,11 @@
.. _Docstring Processing System: http://docstring.sourceforge.net/
.. _master PEP repository: https://peps.python.org/
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/ref/rst/restructuredtext.txt
===================================================================
--- trunk/docutils/docs/ref/rst/restructuredtext.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/ref/rst/restructuredtext.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -3283,10 +3283,11 @@
.. _Zope: http://www.zope.com/
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
Modified: trunk/docutils/docs/user/emacs.txt
===================================================================
--- trunk/docutils/docs/user/emacs.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/user/emacs.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -945,16 +945,15 @@
.. _reStructuredText: https://docutils.sourceforge.io/rst.html
.. _Docutils: https://docutils.sourceforge.io/
-
+.. Emacs settings
-.. LocalWords: reST utf Merten Blais rst el docutils modeline emacs
-.. LocalWords: Init mEmacs sInit alist setq txt overlines RET nd py
-.. LocalWords: dwim conf toolset pseudoxml pdf Imenu imenu menubar
-.. LocalWords: func toc xmlunicode unichars eacute charset fontset
-.. LocalWords: kTextEncodingISOLatin charsets monaco ascii latin
-.. LocalWords: iso unicode Choi's Goodger Guo
+ LocalWords: reST utf Merten Blais rst el docutils modeline emacs
+ LocalWords: Init mEmacs sInit alist setq txt overlines RET nd py
+ LocalWords: dwim conf toolset pseudoxml pdf Imenu imenu menubar
+ LocalWords: func toc xmlunicode unichars eacute charset fontset
+ LocalWords: kTextEncodingISOLatin charsets monaco ascii latin
+ LocalWords: iso unicode Choi's Goodger Guo
-..
Local Variables:
mode: rst
indent-tabs-mode: nil
Modified: trunk/docutils/docs/user/tools.txt
===================================================================
--- trunk/docutils/docs/user/tools.txt 2024-05-03 09:47:45 UTC (rev 9671)
+++ trunk/docutils/docs/user/tools.txt 2024-05-03 09:48:07 UTC (rev 9672)
@@ -555,10 +555,11 @@
.. _configuration file sections:
config.html#configuration-file-sections-entries
-
-..
+.. Emacs settings
+
Local Variables:
mode: indented-text
+ mode: rst
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.