Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.8.3: documentation uses recommonmark which is now deprecated #337

Closed
kloczek opened this issue Jan 27, 2024 · 1 comment · Fixed by #340
Closed

1.8.3: documentation uses recommonmark which is now deprecated #337

kloczek opened this issue Jan 27, 2024 · 1 comment · Fixed by #340

Comments

@kloczek
Copy link

kloczek commented Jan 27, 2024

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 docs/source build/sphinx/man
Running Sphinx v7.1.2

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 356, in eval_config_file
    exec(code, namespace)  # NoQA: S102
  File "/home/tkloczko/rpmbuild/BUILD/python-gssapi-1.8.3/docs/source/conf.py", line 23, in <module>
    from custom_recommonmark import AllCodeCommonMarkParser
  File "/home/tkloczko/rpmbuild/BUILD/python-gssapi-1.8.3/docs/custom_extensions/custom_recommonmark.py", line 1, in <module>
    from recommonmark.parser import CommonMarkParser
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 207, in __init__
    self.config = Config.read(self.confdir, confoverrides or {}, self.tags)
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 179, in read
    namespace = eval_config_file(filename, tags)
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 369, in eval_config_file
    raise ConfigError(msg % traceback.format_exc()) from exc
sphinx.errors.ConfigError: There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 356, in eval_config_file
    exec(code, namespace)  # NoQA: S102
  File "/home/tkloczko/rpmbuild/BUILD/python-gssapi-1.8.3/docs/source/conf.py", line 23, in <module>
    from custom_recommonmark import AllCodeCommonMarkParser
  File "/home/tkloczko/rpmbuild/BUILD/python-gssapi-1.8.3/docs/custom_extensions/custom_recommonmark.py", line 1, in <module>
    from recommonmark.parser import CommonMarkParser
ModuleNotFoundError: No module named 'recommonmark'


Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/usr/lib/python3.8/site-packages/sphinx/config.py", line 356, in eval_config_file
    exec(code, namespace)  # NoQA: S102
  File "/home/tkloczko/rpmbuild/BUILD/python-gssapi-1.8.3/docs/source/conf.py", line 23, in <module>
    from custom_recommonmark import AllCodeCommonMarkParser
  File "/home/tkloczko/rpmbuild/BUILD/python-gssapi-1.8.3/docs/custom_extensions/custom_recommonmark.py", line 1, in <module>
    from recommonmark.parser import CommonMarkParser
ModuleNotFoundError: No module named 'recommonmark'
@jborean93
Copy link
Contributor

Thanks for the report, #340 migrates away from recommonmark to MyST.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants