Comments (10)
Looks good to me!
from scores.
Btw the FSS stuff looks fine to me otherwise. The above suggestion is probably for a different issue.
from scores.
Notes:
- The tutorial links will 404. (When this happens, I change "latest" to "develop" to check the link will work when merged to main)
- The API links will incorrectly resolve to the top of the API documentation page. (Again, I change "latest" to "develop", and then check it resolves to the correct section of the API documentation)
from scores.
strange... not sure why develop references api from "latest"...
from scores.
strange... not sure why develop references api from "latest"...
Tennessee and I have adopted this strategy deliberately. We can't use relative paths, as the relative paths don't work across GitHub, PyPI and readthedocs.
Tennessee is planning to do another merge to main fairly soon, so the links will work after that.
The alternative (which we did try previously), is to first includes link to develop, then manually search for and manually update every develop link before each merge to main. While we started off doing that, we changed to the current strategy.
from scores.
If either of you are aware of a better strategy for the links, please feel free to share. Tennessee and I know the current approach isn't ideal, it was just the best we could come up with!
from scores.
This should in theory work: https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#inline-links-with-implicit-text
I'll just quickly test it out
from scores.
An additional note (which I didn't include before): within the same page, relative paths work fine.
For instance, in the Contributing Guide (https://scores.readthedocs.io/en/develop/contributing.html), I have can included things such as "Please follow the workflow for submitting pull requests outlined above." - and the #workflow-for-submitting-pull-requests will take me to that section on that page.
My understanding is one of the biggest issue was links in the README.md not resolving in PyPI - I think in the early days (when I wasn't involved), this caused a fair few problems. So I think that was Tennessee's initial motivation to use full URLs.
Tennessee also said there were issues with links behaving differently in GitHub versus readthedocs.
from scores.
Ok so here are examples that worked for me:
[API](project:./api.md#scores.continuous.additive_bias)
[Tutorial](project:./tutorials/Flip_Flop_Index.md)
The main difference is the project:
prefix and instead of .html
targetting .md
. That should allow you to strip out the absolute parts hopefully, again hard to tell without actually pushing it and building it with readthedocs.
As you say they may not work on md
files that are shared between what's in github and readthedocs. Although I think any links in github README.md
should probably just point to "latest" or github itself.
I think its mainly nice to have the API/tutorials in sync with the appropriate branch.
from scores.
Thanks for coming up with that approach Nikeeth. In the past, there were so many issues, I think it will involve some time to really test any new way of doing things, so I'm going to hold that off until after version 1.0 when we can take some time over it. I'll make a note and keep it on a list of things to look into in future.
from scores.
Related Issues (20)
- [JOSS] Consider tracking coverage HOT 3
- [JOSS] Number scheme is not explained HOT 2
- [JOSS] JOSS statement of need should be expanded HOT 4
- [JOSS] Mention binder availability in README HOT 2
- [JOSS] Add a end-to-end example HOT 3
- [JOSS] Fix warnings in test suite and examples HOT 6
- Support for distributed testing HOT 1
- Deprecation warning in tutorial for Pearson's correlation coefficient
- Add a "Key Features of `scores`" page to the documentation
- Key Features page in docs - follow up questions HOT 6
- Tutorial Gallery - put headers in own cells so they render better in readthedocs
- [JOSS] Installation of jupyer kernel HOT 2
- [JOSS] Instructions for downloading example data HOT 1
- [JOSS] General explanation of reduce/preserve HOT 3
- [JOSS] Minimal pandas support HOT 4
- [JOSS] Implementation of weights is occasionally unclear HOT 1
- rename correlation HOT 1
- Badges, CI and forks HOT 2
- roc_curve_data API rendering in readthedocs HOT 1
- Add threshold weighted scores
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from scores.