I314 numref hoverxref #315
Conversation
requirements.txt
Outdated
| @@ -1,3 +1,3 @@ | |||
| sphinx>2,<3 | |||
| sphinx-hoverxref | |||
| git+git://github.com/readthedocs/sphinx-hoverxref.git@master | |||
There was a problem hiding this comment.
Hmm... not keen on this. master seems to be a wip type of branch. So, who knows, it may at some point contain something that could break things for us. You say that they have fixed the issue numref. Is that this commit: readthedocs/sphinx-hoverxref@3558a67? If so, and if anything, we might want to point to that one rather than master itself. However, my preference would on using an official version of sphinx-hoverxref.
There was a problem hiding this comment.
Yes, that's the commit. I've tried using just the plain sphinx-hoverxref requirement in the file, and it didn't seem to be building it in properly (either that or the cache clearing / readthedocs wiping wasn't being very thorough?). I'm not sure what the "official" sphinx-hoverxref would point to other than the master branch though?
There was a problem hiding this comment.
I guess I could ask when the next release will be (seems to be quite frequently) so then we can tie it to a tag - that's probably cleaner?
There was a problem hiding this comment.
The official sphinx-hoverxref version is 0.3b1 (as confirmed by my local copy of sphinx-hoverxref and https://github.com/readthedocs/sphinx-hoverxref/releases). So, yes, ideally we would ask them for a new release with the numref fix and keep using sphinx-hoverxref rather than git+git://github.com/readthedocs/sphinx-hoverxref.git@master or something else.
There was a problem hiding this comment.
They're aiming for another release next week ... fingers crossed :)
There was a problem hiding this comment.
Great. Ping us again in a week's time. :)
|
Discussion here re getting release version with our changes: readthedocs/sphinx-hoverxref#71 |
|
New release all done :) @agarny all good now? |
|
Right.... done ... @agarny ? |
|
There's no CI on this spec repo? And it's working fine, see rendered version here: https://cellml-specification-dev.readthedocs.io/en/i314_numref_hoverxref/reference/formal_and_informative/specC01_interpretation_of_imports.html (hover over the numbered links) |
|
Oops, my bad, sorry! I was in libCellML mode... 🥴 |
Closes #314
... but ... this currently is proof of concept as it requires a branch from the hoverxref repo. It can be merged now if we're desperate, or we can wait for it to be included in their update.
See change in the requirements file that would need to be reverted.
Rendered docs are here: https://cellml-specification-dev.readthedocs.io/en/i314_numref_hoverxref/reference/formal_and_informative/specB09.html