Skip to content

Commit 8917f46

Browse files
committed
Fix RtD links and Update documentation links and naming.
Updated documentation links and clarified naming conventions in index.md and README.md. Changed the reference to the license from the generic term [license] to [Apache 2.0 license]. Additionally, the [command-line reference] has been renamed to [Command-line Usage], and [API Reference] was added for clarity. These changes improve the user's understanding of the content and ensure that the information is accurately linked.
1 parent c614a87 commit 8917f46

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
[![Conda](https://img.shields.io/conda/vn/conda-forge/multidimio)][install_conda]
1414
[![Python Version](https://img.shields.io/pypi/pyversions/multidimio)][python version]
1515
[![Status](https://img.shields.io/pypi/status/multidimio.svg)][status]
16-
[![License](https://img.shields.io/pypi/l/multidimio)][license]
16+
[![License](https://img.shields.io/pypi/l/multidimio)][apache 2.0 license]
1717

1818
[![Tests](https://github.com/TGSAI/mdio-python/workflows/Tests/badge.svg)][tests]
1919
[![Codecov](https://codecov.io/gh/TGSAI/mdio-python/branch/main/graph/badge.svg)][codecov]
@@ -83,14 +83,14 @@ $ conda install -c conda-forge multidimio
8383

8484
> Extras must be installed separately on `Conda` environments.
8585
86-
For details, please see the [installation instructions][install]
86+
For details, please see the [installation instructions]
8787
in the documentation.
8888

8989
# Using MDIO
9090

91-
Please see the [Command-line Reference][usage] for details.
91+
Please see the [Command-line Usage] for details.
9292

93-
For Python API please see the [API Reference][reference] for details.
93+
For Python API please see the [API Reference] for details.
9494

9595
# Requirements
9696

@@ -113,7 +113,7 @@ To learn more, see the [Contributor Guide].
113113

114114
# Licensing
115115

116-
Distributed under the terms of the [Apache 2.0 license][license],
116+
Distributed under the terms of the [Apache 2.0 license],
117117
_MDIO_ is free and open source software.
118118

119119
# Issues
@@ -151,8 +151,8 @@ template.
151151

152152
<!-- github-only -->
153153

154-
[license]: https://github.com/TGSAI/mdio-python/blob/main/LICENSE
154+
[apache 2.0 license]: https://github.com/TGSAI/mdio-python/blob/main/LICENSE
155155
[contributor guide]: https://github.com/TGSAI/mdio-python/blob/main/CONTRIBUTING.md
156-
[usage]: https://mdio-python.readthedocs.io/en/latest/usage.html
157-
[reference]: https://mdio-python.readthedocs.io/en/latest/reference.html
158-
[install]: https://mdio-python.readthedocs.io/en/latest/installation.html
156+
[command-line usage]: https://mdio-python.readthedocs.io/en/latest/usage.html
157+
[api reference]: https://mdio-python.readthedocs.io/en/latest/reference.html
158+
[installation instructions]: https://mdio-python.readthedocs.io/en/latest/installation.html

docs/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ end-before: <!-- github-only -->
44
---
55
```
66

7-
[license]: license
7+
[apache 2.0 license]: license
88
[contributor guide]: contributing
9-
[command-line reference]: usage
9+
[command-line usage]: usage
10+
[api reference]: reference
11+
[installation instructions]: installation
1012

1113
```{toctree}
1214
---

0 commit comments

Comments
 (0)