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

Problem with latest Sphinx and I18N #3

Closed
odscjames opened this issue Jun 7, 2018 · 7 comments
Closed

Problem with latest Sphinx and I18N #3

odscjames opened this issue Jun 7, 2018 · 7 comments

Comments

@odscjames
Copy link

Didn't know where else to document this so triying here ...

I've been working on a repo with sphinx==1.7.5, trying I18N. It broke.

With an error in docutils:

document.settings has no attribute 'tab_width'

This is the patch that needs to be applied to docutils to fix the error: https://github.com/docutils-mirror/docutils/pull/14/commits/c8ffd504b65e4b4f2f00677545f10f1d5a515199

However, docutils has not released a version with that patch.

I couldn't install a version of docutils with a git commit because the source is in SVN. I couldn't install a version of docutils with a SVN version because the code in the master SVN branch is Python 2. I then tried creating our own git repo, and applying the patch by hand, but I couldn't because I couldn't get a full copy of the source code of docutils in Python 3, only Python 2.

In the end I downgraded the sphinx version to sphinx==1.6.7. Then I cried.

@Bjwebb
Copy link
Member

Bjwebb commented Jun 14, 2018

You should be able to install that commit from the docutils-mirror on github with pip install -e git+https://github.com/docutils-mirror/docutils.git@c8ffd504b65e4b4f2f00677545f10f1d5a515199#egg=docutils

@odscjames
Copy link
Author

I guess early on I didn't try that because it felt wrong to be locking to a patch that was just a P.R. and hadn't been merged in - It wouldn't have any further work. Tho later on I got frustrated enought to try and create a Python 3 mirror of the latest code so 🤷‍♂️ But generally this all feels very brittle and flakey in a way which isn't great.

@Bjwebb
Copy link
Member

Bjwebb commented Jun 15, 2018

Yeah, agree that it's not great. At the very least though, it could be a useful way to check that the patch actually fixes the problem.

@odscjames
Copy link
Author

Think I just hacked the source files by hand on my VM to verify that :-)

@jpmckinney
Copy link

Adding link to my prior work to get this working: https://ocds-babel.readthedocs.io/en/latest/api/translate.html#install-requirements-for-markdown-translation

Recently found https://sphinx-book-theme.readthedocs.io/en/latest/ which uses https://markdown-it-py.readthedocs.io/en/latest/ instead of CommonMark.py and https://myst-parser.readthedocs.io/en/latest/ instead of recommonmark. ExecutableBooks seems like a way more responsible maintainer than ReadTheDocs. See open-contracting/standard_profile_template#37

@jpmckinney
Copy link

recommonmark will be sunset in about a month: readthedocs/recommonmark#221

@Bjwebb
Copy link
Member

Bjwebb commented Aug 4, 2022

This repo no longer uses recommonmark.

@Bjwebb Bjwebb closed this as completed Aug 4, 2022
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

No branches or pull requests

3 participants