0.8.1: documentation uses recommonmark which is now deprecated

[kloczek]

From https://github.com/readthedocs/recommonmark

Warning: recommonmark is now deprecated. We recommend using MyST for a docutils bridge going forward. See readthedocs/recommonmark#221 for background and discussion.

+ /usr/bin/sphinx-build -n -T -b man doc build/sphinx/man
Running Sphinx v7.1.2

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/registry.py", line 441, in load_extension
    mod = import_module(extname)
  File "/usr/lib64/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 973, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'recommonmark'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/cmd/build.py", line 285, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 229, in __init__
    self.setup_extension(extension)
  File "/usr/lib/python3.8/site-packages/sphinx/application.py", line 402, in setup_extension
    self.registry.load_extension(self, extname)
  File "/usr/lib/python3.8/site-packages/sphinx/registry.py", line 444, in load_extension
    raise ExtensionError(__('Could not import extension %s') % extname,
sphinx.errors.ExtensionError: Could not import extension recommonmark (exception: No module named 'recommonmark')

Extension error:
Could not import extension recommonmark (exception: No module named 'recommonmark')

[iustin]

It is deprecated, but the issue here is that you don't have it installed. So to fix your problem, make sure to install recommonmark for now,

[iustin]

Just saw that this is part of a mass bug filling. I'll take care of it, but not immediately.

[kloczek]

Just saw that this is part of a mass bug filling. I'll take care of it, but not immediately.

OK. Thx.
Currently only handful of python modules uses recommonmark 😋

[iustin]

This is now complete, and I've checked (visually) that the documentation is still correct via prebuild at https://pyxattr.readthedocs.io/latest/readme.html. Thanks!

[kloczek]

As I'm packaging man pages so I've tested generate man page and I was able to generate man page however because I'm using sphinx with -n option this exposed some issues

+ /usr/bin/sphinx-build -n -T -b man doc build/sphinx/man
Running Sphinx v7.1.2
making output directory... done
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 6 added, 0 changed, 0 removed
reading sources... [100%] security
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-pyxattr.3 { readme contributing security module news } /home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.list:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.list:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get_all:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get_all:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.get_all:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: integer
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.set:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.remove:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.remove:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.remove:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.getxattr:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.getxattr:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.getxattr:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: integer
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.setxattr:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.listxattr:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.listxattr:1: WARNING: py:class reference target not found: optional
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.removexattr:1: WARNING: py:class reference target not found: string
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.removexattr:1: WARNING: py:class reference target not found: boolean
/home/tkloczko/rpmbuild/BUILD/pyxattr-0.8.1/docstring of xattr.removexattr:1: WARNING: py:class reference target not found: optional
done
build succeeded, 30 warnings.

You can peak on fixes that kind of issues in other projects
RDFLib/rdflib-sqlalchemy#95
RDFLib/rdflib#2036
click-contrib/sphinx-click@abc31069
frostming/unearth#14
jaraco/cssutils#21
latchset/jwcrypto#289
latchset/jwcrypto#289
pypa/distlib@98b9b89f
pywbem/pywbem#2895
sissaschool/elementpath@bf869d9e
sissaschool/xmlschema@42ea98f2
sqlalchemy/sqlalchemy@5e88e6e8