[PyFDB] docs: Markdown fix and reference to FDB docs#262
[PyFDB] docs: Markdown fix and reference to FDB docs#262
Conversation
0013735 to
440353a
Compare
There was a problem hiding this comment.
Pull request overview
Updates the PyFDB wheel README to remove Sphinx/reStructuredText artifacts and point users toward the upstream FDB documentation/resources.
Changes:
- Converted FDB references from reStructuredText link syntax to Markdown.
- Reordered and rewrote the “Documentation” section to reference FDB project pages and upstream repo guidance.
- Normalized command snippet formatting in the installation section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # PyFDB | ||
|
|
||
| `PyFDB` is the Python interface to the `FDB <github.com/ecmwf/fdb>`__, a | ||
| `PyFDB` is the Python interface to the [FDB](github.com/ecmwf/fdb), a |
There was a problem hiding this comment.
The Markdown link target github.com/ecmwf/fdb is missing a URL scheme, so GitHub will treat it as a relative link. Use an absolute URL (e.g., https://github.com/ecmwf/fdb).
| and notebooks. | ||
|
|
||
| The `FDB <github.com/ecmwf/fdb>`__ itself is part of `ECMWF`’s | ||
| The [FDB](github.com/ecmwf/fdb) itself is part of `ECMWF`’s |
There was a problem hiding this comment.
This Markdown link also uses github.com/ecmwf/fdb without a scheme, which will render as a relative link. Update to https://github.com/ecmwf/fdb.
|
|
||
| ## Documentation | ||
|
|
||
| For implementation details and tooling, see the `[FDB project pages](https://fields-database.readthedocs.io/en/latest/index.html). |
There was a problem hiding this comment.
There is an unmatched opening backtick before the link text, which will break Markdown rendering for the rest of the line/section. Remove the stray backtick (or add the matching closing backtick) so the link renders correctly.
| For implementation details and tooling, see the `[FDB project pages](https://fields-database.readthedocs.io/en/latest/index.html). | |
| For implementation details and tooling, see the [FDB project pages](https://fields-database.readthedocs.io/en/latest/index.html). |
|
|
||
| For implementation details and tooling, see the `[FDB project pages](https://fields-database.readthedocs.io/en/latest/index.html). | ||
|
|
||
| To build the latest documentation locally, follow the guide at [FDB](github.com/ecmwf/fdb). |
There was a problem hiding this comment.
This link target is missing a URL scheme (github.com/ecmwf/fdb), which makes it a relative link in Markdown. Use https://github.com/ecmwf/fdb instead.
| To build the latest documentation locally, follow the guide at [FDB](github.com/ecmwf/fdb). | |
| To build the latest documentation locally, follow the guide at [FDB](https://github.com/ecmwf/fdb). |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #262 +/- ##
========================================
Coverage 71.19% 71.19%
========================================
Files 376 376
Lines 23762 23762
Branches 2478 2478
========================================
Hits 16918 16918
Misses 6844 6844 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Description
Modified readme.md for pyfdb wheel.
Removed sphinx artifacts and added reference to FDB documentation.
Contributor Declaration
By opening this pull request, I affirm the following:
🌈🌦️📖🚧 Documentation FDB 🚧📖🌦️🌈
https://sites.ecmwf.int/docs/dev-section/fdb/pull-requests/PR-262