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

Double-check case sensitivity of anchor links #147

Closed
jpfeuffer opened this issue Oct 14, 2021 · 12 comments · Fixed by #399
Closed

Double-check case sensitivity of anchor links #147

jpfeuffer opened this issue Oct 14, 2021 · 12 comments · Fixed by #399

Comments

@jpfeuffer
Copy link
Contributor

Because the case sensitivity might be different between RST and ipynb (stricter).

E.g. (Peptide identification section)[#peptideidentification] to (Peptide identification section)[#PeptideIdentification]

@timosachsenberg
Copy link
Contributor

might need to be added to PR template

@jpfeuffer
Copy link
Contributor Author

Or "mass-defect" vs "Mass-Defect"

@poshul poshul self-assigned this Oct 22, 2021
@poshul
Copy link
Collaborator

poshul commented Oct 25, 2021

These are all done except for wrap_classes, which was causing me issues.

@jpfeuffer
Copy link
Contributor Author

What do you mean? Can you post an example reference to the problematic link(s)?

@jpfeuffer
Copy link
Contributor Author

And thanks!

@poshul
Copy link
Collaborator

poshul commented Oct 25, 2021

for example the links to simpleexample and complex example on line 62 don't work in Jupyter. I was still fighting with the syntax to get them to work on Friday, but haven't had a chance to finish up that work, and likely wont in the next couple of days.

@jpfeuffer
Copy link
Contributor Author

jpfeuffer commented Oct 25, 2021

Ah I see. Those are special RST style links SimpleExample_. They point to an additional HTML span element created with e.g. .. _SimpleExample.
I don't think this (empty) span is converted into markdown of the ipynb.
It is probably better if we use "normal" links to headers that are always present:

`simple example <#A-simple-example>`_

or something like this.

@tapaswenipathak
Copy link
Contributor

@greengypsy: can you check if there is existing documentation for this? If not, add and close?

@matteopilz
Copy link
Contributor

The class & function references are also not working now, how should we do this?

@jpfeuffer
Copy link
Contributor Author

You mean in ipynb? It never worked. ipynb has no knowledge about the API documentation. We could only link back to the readthedocs page. Could be done with another custom pandoc "plugin" that looks for :py:class: roles during conversion and treats them specially.

@matteopilz
Copy link
Contributor

Yes, in ipynb. It probably wasn't mentioned before, because we only had a few of them. I will look into pandoc and try to find out if we can write a conversion script / plugin.

@matteopilz matteopilz moved this from Todo to In Progress in Sprint May 15 - May 29 May 26, 2023
@jpfeuffer
Copy link
Contributor Author

@matteopilz matteopilz linked a pull request May 31, 2023 that will close this issue
@matteopilz matteopilz moved this from In Progress to Done in Sprint May 15 - May 29 Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

6 participants