Comments (4)
So, this worked locally but raised a sphinx-build error. It seems to me like the autodoc command is generating the anchor in api.html after myst runs to generate the other html files. As such, at the time it's running, it thinks the cross-reference is missing in api.html. After some searching, I found out how to suppress the warning site-wide, not not a true fix. As such, we can do this, but it runs the risk of suppressing genuine cross-referencing errors between other files in the documentation.
Adding suppress_warnings = ['myst.xref_missing']
to conf.py suppresses the error.
I will try pushing the change to 228 and confirming it works as expected on the site proper, but I expect it will. So this is a possible way forward, but with some downsides.
from scores.
I have now quieted the cross-referencing error noted during build through a configuration setting in conf.py. This opens the door for changing API docstring links in the manner outlined above. It does not appear to be required to specify the project: prefix, just remove the URL prefix and change .html to .md.
from scores.
Example: [API](api.md#scores.continuous.additive_bias)
from scores.
I have now quieted the cross-referencing error noted during build through a configuration setting in conf.py. This opens the door for changing API docstring links in the manner outlined above. It does not appear to be required to specify the project: prefix, just remove the URL prefix and change .html to .md.
I can’t remember now, but I think to reference tutorials I needed the “project:” prefix or it gets confused; but maybe my setup was being weird. It can be omitted for api.md
from scores.
Related Issues (20)
- [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
- Go through and add thumbnails to each tutorial gallery entry
- Kling-Gupta efficiency and percentage bias HOT 10
- Add link to JOSS article towards start of README HOT 5
- Brier Score - References in API & Tutorial
- Relative Economic value
- Badges for PyPI and Conda
- twcrps for ensembles
- Update Maintainers Notes
- Mathjax: x and y vs forecast and observed
- reprojection tutorial
- scipy isotonic regression
- Add JOSS markdown badge
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.