Skip to content
This repository has been archived by the owner on Mar 25, 2022. It is now read-only.

Recommonmark not working with Sphinx 1.6 #73

Closed
ratiotile opened this issue May 24, 2017 · 2 comments
Closed

Recommonmark not working with Sphinx 1.6 #73

ratiotile opened this issue May 24, 2017 · 2 comments

Comments

@ratiotile
Copy link

Recommonmark 0.4.0
Was working with Sphinx 1.5. When I updated to 1.6, build no longer works.

Exception occurred:
  File "python3.4/site-packages/recommonmark/states.py", line 134, in run_role
    content=content)
TypeError: 'NoneType' object is not callable
@ratiotile
Copy link
Author

Sphinx issue for reference: sphinx-doc/sphinx#3800

@lorengordon
Copy link

Reposting from sphinx-doc/sphinx#3800 (comment), since that issue was closed, and it seems even though the exception doesn't occur with code from master, recommonmark is still not generating links quite right...

...at least part of the problem appears to be that recommonmark hasn't released a version in a bit. The code in that diff isn't present in the master branch. It was removed in the last commit that modified that file.

I adjusted my requirements file to build from the recommonmark master branch and was able to get it to work, sort of. Needed to also modify link references from [file](file.md) to [file](file.html) to get the references to point to a page that will actually load, which is kind of awful.

@scottleibrand scottleibrand mentioned this issue Jan 8, 2018
Closed
hcho3 added a commit to hcho3/xgboost that referenced this issue Feb 21, 2018
@hcho3
Fix doc build
50a73e7 
ReadTheDocs build has been broken for a while due to incompatibilities between
commonmark, recommonmark, and sphinx. See:
* "Recommonmark not working with Sphinx 1.6"
  readthedocs/recommonmark#73
* "CommonMark 0.6.0 breaks compatibility"
  readthedocs/recommonmark#24
For now, we fix the versions to get the build working again
@hcho3 hcho3 mentioned this issue Feb 21, 2018
Merged
hcho3 added a commit to dmlc/xgboost that referenced this issue Feb 22, 2018
@hcho3
Fix doc build (#3126)
3d7aff5 
* Fix doc build

ReadTheDocs build has been broken for a while due to incompatibilities between
commonmark, recommonmark, and sphinx. See:
* "Recommonmark not working with Sphinx 1.6"
  readthedocs/recommonmark#73
* "CommonMark 0.6.0 breaks compatibility"
  readthedocs/recommonmark#24
For now, we fix the versions to get the build working again

* Fix search bar
pgeorgi pushed a commit to coreboot/coreboot that referenced this issue Sep 30, 2018
@Thrilleratplay @zaolin
Documentation: Disable auto_doc_ref
ffe6d54 
According to recommonmark's documentation the enable_auto_doc_ref is deprecated.
This is not true, as it's broken with Sphinx 1.6+ commit
12d639873953847de31ec99742b42e50e89ed58c.

recommonmark bug report is here: readthedocs/recommonmark#73

Instead of using this feature, which doesn't support top level directories in
the relative document path anyway, use the TOC tree or inline RST code.

Disable auto_doc_ref and document how to reference documents.

Change-Id: I9319985b504c4215c33ebbeb9c38317b9efcb283
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com>
Reviewed-on: https://review.coreboot.org/28550
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Tom Hiller <thrilleratplay@gmail.com>
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ericholscher @ratiotile @lorengordon