Enabling doc8 stylecheck #29

Author: eviau-artefactual

.pre-commit-config.yaml

@@ -1,5 +1,10 @@
 repos:
-  - repo: https://github.com/sphinx-contrib/sphinx-lint
-    rev: "v0.9.1"
-    hooks:
-      - id: sphinx-lint
+- repo: https://github.com/sphinx-contrib/sphinx-lint
+  rev: "v0.9.1"
+  hooks:
+  - id: sphinx-lint
+- repo: https://github.com/PyCQA/doc8
+  rev: v1.1.1
+  hooks:
+  - id: doc8
+    files: ^docs/.*\.rst$

docs/contact.rst

@@ -1,6 +1,7 @@
 Contact us
 ==========
 
-To get in touch with us, write us an email at `[email protected] <mailto:[email protected]>`__.
+To get in touch with us, write us an email at
+`[email protected] <mailto:[email protected]>`__.
 
 

docs/dependencies.rst

@@ -18,7 +18,8 @@ Archivematica consists of several projects working together.
 - `Storage Service <https://github.com/artefactual/archivematica-storage-service>`__: Responsible for moving files to Archivematica for processing, and from Archivematica into storage
   - and the associated `Storage Service Documentation <https://github.com/artefactual/archivematica-storage-service-docs>`__
 
-There are also several smaller repositories that support Archivematica in various ways. In general, you will not need these to develop on Archivematica.
+There are also several smaller repositories that support Archivematica in
+various ways. In general, you will not need these to develop on Archivematica.
 
 - `AM client <https://github.com/artefactual-labs/amclient>`__ : Archivematica API client module
 - `AMmcpc <https://github.com/artefactual-labs/ammcpc>`__ : Archivematica MediaConch policy check wrapper

docs/digipres.rst

@@ -120,20 +120,22 @@ Talks
 -----
 
 Many interesting talks on digital preservation have been made
-vailable online, such as
-this one on the `Learn with Scholars Portal on digital preservation and what it looks like`_,
+vailable online, such as this one on the
+`Learn with Scholars Portal on digital preservation and what it looks like`_,
 and this `video of talk by Trevor Owens on communities and platform`_.
 
 And... many more!
 ------------------
 
-This list was not meant to be exhaustive - here a few other links as a conclusion:
+This list was not meant to be exhaustive - here a few other links as a
+conclusion:
 
 - `Unesco’s charter on the preservation of digital heritage`_
 - `Sustainability of digital formats`_
 - `Levels of digital preservation`_ to help you build or assess a program
 
-If we missed something that was helpful to you on your digital preservation journey, consider `opening an issue to add it`_.
+If we missed something that was helpful to you on your digital preservation
+journey, consider `opening an issue to add it`_.
 
 .. _`Novice to Know-How: Digital Preservation for Beginners`: https://dpc.getlearnworlds.com/course/novice-to-know-how-beginners
 .. _`Digital Preservation Coalition`: https://www.dpconline.org/digipres

docs/i18n.rst

@@ -1,7 +1,9 @@
 Internationalization
 ====================
 
-One way you can get involved with our projects is through translation and localizations efforts, helping us reach a broader international audience by making meaningful, useful tools for digital preservation.
+One way you can get involved with our projects is through translation and
+localizations efforts, helping us reach a broader international audience by
+making meaningful, useful tools for digital preservation.
 
 Here are the current efforts we help maintain for each project.
 
@@ -16,25 +18,28 @@ For the AtoM, here is `more information about contributing documentation transla
 User interface
 ______________
 
-In AtoM documentation, there is a `Translate section <https://accesstomemory.org/docs/latest/#translate>`__ on how to translate both database contents and user interface elements in AtoM.
+In AtoM documentation, there is a
+`Translate section <https://accesstomemory.org/docs/latest/#translate>`__ on
+how to translate both database contents and user interface elements in AtoM.
 
 Archivematica
 -------------
 
 Documentation
 _____________
 
-At the moment speaking, there are some partial translations of Archivematica documentation, but no guidelines to follow for doing one. You will find the `.po files on GitHub <https://github.com/artefactual/archivematica-docs/tree/1.16/locale>`__.
+At the moment speaking, there are some partial translations of Archivematica
+documentation, but no guidelines to follow for doing one. You will find the
+`.po files on GitHub <https://github.com/artefactual/archivematica-docs/tree/1.16/locale>`__.
 
 User interface
 ______________
 
-We are not currently working on translations for the Archivematica UI, in date of March 2024. You can `access previous documentation for translating the AM user interface <https://archivematica.org/docs/latest/user-manual/translations/translations/>`__.
+We are not currently working on translations for the Archivematica UI, in date
+of March 2024. You can `access previous documentation for translating the AM user interface <https://archivematica.org/docs/latest/user-manual/translations/translations/>`__.
 
 
 Enduro
 ------
 
 There is no current internationalization effort for Enduro.
-
-

requirements.txt

@@ -5,7 +5,8 @@ certifi==2024.7.4
 cfgv==3.4.0
 charset-normalizer==3.3.2
 distlib==0.3.8
-docutils==0.21.2
+doc8==1.1.1
+docutils==0.20.1
 filelock==3.15.4
 furo==2024.8.6
 identify==2.6.0
@@ -15,11 +16,13 @@ Jinja2==3.1.4
 MarkupSafe==2.1.5
 nodeenv==1.9.1
 packaging==24.1
+pbr==6.0.0
 platformdirs==4.2.2
 pre-commit==3.8.0
 Pygments==2.18.0
 PyYAML==6.0.2
 requests==2.32.3
+restructuredtext-lint==1.4.0
 snowballstemmer==2.2.0
 soupsieve==2.6
 Sphinx==8.0.2
@@ -30,6 +33,7 @@ sphinxcontrib-htmlhelp==2.1.0
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==2.0.0
 sphinxcontrib-serializinghtml==2.0.0
+stevedore==5.3.0
 tomli==2.0.1
 urllib3==2.2.2
 virtualenv==20.26.3