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

Make BioC links consistent #158

Open
sjspielman opened this issue Oct 10, 2023 · 5 comments
Open

Make BioC links consistent #158

sjspielman opened this issue Oct 10, 2023 · 5 comments

Comments

@sjspielman
Copy link
Member

The docs hop around among lots of bioconductor releases versions for relevant links (packages and OSCA). We should pick one and go with it. For ease of maintenance, I propose release...

@jashapiro
Copy link
Member

Alternatively, we might try to match the version we are using in the current scpca-nf. I suspect that release is usually fine, but we want to discuss.

@allyhawkins
Copy link
Member

We're using 3.17 in scpca-nf. I feel like there must be a way we can fill the versions automatically to match the version in scpca-nf before we merge things into main. That would eliminate us needing to constantly go through and update all the links.

@sjspielman
Copy link
Member Author

I feel like there must be a way we can fill the versions automatically to match the version in scpca-nf before we merge things into main.

I like this idea. We'd want to match the version in the scpcaTools container, and probably use something like this -

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#substitution-definitions

@allyhawkins
Copy link
Member

I think this is related to Josh's comment about versions in readthedocs (see #157 (review)). We might want to have a separate discussion about how we want to manage versions for this repo first, and then address this.

@jashapiro
Copy link
Member

W

I feel like there must be a way we can fill the versions automatically to match the version in scpca-nf before we merge things into main.

I like this idea. We'd want to match the version in the scpcaTools container, and probably use something like this -

Those links actually don't apply to our docs, as we are writing in markdown, not rst. What we might need to do is to enable a MyST extension and describe the replacements in the conf.py, as described in https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2

Note that doing the substitution in a URL (our use case) is a bit more complicated!: https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-and-urls

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